View Demo · Report Bug · Request Feature

🗂️ Table of Contents

1. About The Project
   • Home Page
   • SignIn/SignUp Page
   • Dashboard
   • Create New Course
   • Course Detail
2. Tech Stack
3. Getting Started
   • Prerequisites
   • Installation
4. Contributing
5. License
6. Contact

🚀 Home

Rise is a cutting-edge AI-powered Learning Management System (LMS) SaaS app built with Next.js. It empowers educators and learners with advanced functionalities designed to enhance and personalize the learning experience. The platform offers:

• 💡 Advanced AI capabilities for dynamic content generation.
• 🔐 Secure authentication powered by Clerk.
• 💳 Seamless payment processing with Stripe.
• ⚡ Efficient serverless functions using Inngest.
• 🗄️ Robust database management with Neon DB.
• 🎨 A modern, responsive UI built with React and Tailwind CSS.

🏠 Home Page

Description:
The Home Page offers an intuitive dashboard with a modern layout that highlights key courses, features, and announcements. Users can easily navigate through different sections and quickly access the platform's main functionalities.

SignIn / SignUp

Description:
The SignIn/SignUp page provides a secure and seamless authentication experience. New users can register effortlessly, while returning users enjoy a streamlined login process powered by Clerk.

Dashboard

Description:
The Dashboard serves as the central hub for users. It displays, course progress, option to view profile and upgrade tier and quick access to essential tools, allowing educators and learners to manage their activities effectively.

📝 Create New Course

Description:
This process allows educators to create new courses. The interface is designed for simplicity, enabling users to input course details, and configure course settings with ease.

📝 Course Detail

Description:
The Course Detail page provides a comprehensive view of the course content, including:

• Study Material: Quick access to chapters, flashcards, and quizzes.
• Chapters Overview: A list of chapters with descriptions and key highlights.
• AI-Generated Material: Ability to generate notes, flashcards, and quizzes on demand.
• Progress Tracking: See how many chapters are available and monitor completion.
• Interactive Learning: Engage with in-depth explanations, coding examples, and problem-solving techniques.

(back to top)

🛠️ Tech Stack

This project is built using modern technologies to ensure performance and scalability.

Frontend

Backend & Services

Authentication

Additional Libraries

Tooling & Utilities

(back to top)

🚀 Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

📋 Prerequisites

• Node.js (v16.0.0 or higher)
• npm (v7.0.0 or higher)
• Git

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Clone the repo

    git clone https://github.com/ThanhDatVu111/Vroom-Vroom.git
    cd Vroom-Vroom

2. Install NPM packages

   npm install

3. Set up your key

    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_key
    NEXT_PUBLIC_DRIZZLE_DATABASE_URL=your_neon_database_url
    VITE_FIREBASE_API_KEY=your_firebase_key
    VITE_SENDBIRD_APP_ID=your_sendbird_app_id
    VITE_SENDBIRD_API_TOKEN=your_sendbird_token
    NEXT_PUBLIC_DATABASE_CONNECTION_STRING=your_database_connection_string
    CLERK_SECRET_KEY=your_clerk_secret_key
    NEXT_PUBLIC_CLERK_SIGN_IN_URL=your_sign_in_url
    NEXT_PUBLIC_CLERK_SIGN_UP_URL=your_sign_up_url
    NEXT_PUBLIC_GEMINI_API_KEY=your_gemini_api_key
    STRIPE_SECRET_KEY=your_stripe_secret_key
    NEXT_PUBLIC_STRIPE_PRICE_ID=your_stripe_price_id
    HOST_URL=your_host_url
    STRIPE_WEB_HOOK_KEY=your_stripe_webhook_key

4. Set up your Database

    npm run db:generate  # Generate database schemas
    npm run db:push     # Push schemas to your database

5. Start the development server

   npm run dev

(back to top)

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature-name)
3. Commit your Changes (git commit -m 'Add some feature')
4. Push to the Branch (git push origin feature-name)
5. Open a Pull Request

📜 License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

📧 Contact

Thanh Dat Vu - LinkedIn - thanhdatvu.203@gmail.com

Project Link: https://github.com/ThanhDatVu111/Vroom-Vroom

(back to top)