Skip to content

Jared-MB/react-slides

Repository files navigation

React Slides

A modern presentation framework for developers who love React. Create beautiful, interactive presentations with the power of React components and smooth view transitions.

🚀 Features

  • React-Powered - Build your slides using familiar React components
  • Effortless Animations - Smooth view transitions between slides
  • Developer-Friendly - Write your content in Markdown or JSX
  • Themable - Customize the look and feel to match your style
  • Interactive - Add interactive demos using React components

📦 Packages

This monorepo contains the following packages:

presivio

The core slides package containing React components and utilities for creating presentations.

apps/web

A Next.js web application that serves as the main interface for creating and viewing presentations.

🛠️ Getting Started

  1. Clone the repository

    git clone https://github.com/Jared-MB/react-slides.git
    cd react-slides
  2. Install dependencies

    # Using pnpm (recommended)
    pnpm install
    
    # Or using yarn
    yarn install
  3. Start the development server

    # Using pnpm
    pnpm dev
    
    # Or using yarn
    yarn dev

🎯 Creating Your First Presentation

  1. Create a new file in the apps/web/pages directory (e.g., my-presentation.tsx)
  2. Use the Slide and Presentation components to create your slides
  3. Run the development server and navigate to http://localhost:3000/my-presentation

📚 Documentation

For detailed documentation, please visit our documentation site.

🤝 Contributing

Contributions are always welcome! Please read our contributing guide to get started.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •