Skip to content

AI Study Material Generator, a cutting-edge SaaS application designed to revolutionize learning by generating personalized study materials using advanced AI technology

Notifications You must be signed in to change notification settings

Adiaparmar/AI-Study-Material-Generator

Repository files navigation

📚 AI Study Material Generator

Welcome to the AI Study Material Generator, a cutting-edge SaaS application designed to revolutionize learning by generating personalized study materials using advanced AI technology. Built with the latest web development tools and techniques, this platform is perfect for educators, students, and anyone looking to simplify their learning process.


📋 Table of Contents


📝 About the Project

The AI Study Material Generator combines AI capabilities with scalable SaaS architecture to provide a seamless learning experience. With advanced AI features powered by Gemini AI, it generates tailored study materials, quizzes, and summaries, making learning effective and efficient. Whether you're an individual learner or a large institution, this platform adapts to your needs.

Key Goals of the AI Study Material Generator:

  • Simplify the creation of personalized learning materials
  • Enable secure and seamless access to resources
  • Offer a scalable and reliable learning management system

✨ Key Features

  • AI-Powered Material Generation: Uses Gemini AI for generating study materials, quizzes, and summaries.
  • Secure Authentication: Powered by Clerk for robust user authentication.
  • Scalable Serverless Functions: Inngest enables efficient serverless operations.
  • Payment Integration: Stripe supports subscription-based payments for premium users.
  • Responsive Design: Built with Tailwind CSS for a seamless UI/UX.
  • Real-Time Updates: Fast and efficient updates with Next.js server-side rendering and API routes.

🛠 Technologies Used

  • Frontend: React, Next.js, Tailwind CSS
  • Backend: Serverless API routes with Next.js
  • Database: Neon (PostgreSQL-based serverless database)
  • AI Integration: Gemini AI
  • Authentication: Clerk
  • Payments: Stripe
  • Serverless Functions: Inngest

🚀 Getting Started

Prerequisites

Before starting, ensure you have the following installed:

  • Node.js (v16+)
  • npm or Yarn
  • Stripe account
  • Clerk account
  • Neon database instance
  • Inngest account
  • OpenAI (or Gemini AI) API key

Installation

  1. Clone the Repository

    git clone https://github.com/YourUsername/AI-Study-Material-Generator.git
    cd AI-Study-Material-Generator
    
    
  2. Install Dependencies

    npm install
    
    
  3. Set Up Environment Variables

    Create a .env.local file in the root directory and add the following variables:

  4. env

    NEXT_PUBLIC_CLERK_FRONTEND_API=your_clerk_frontend_api
    CLERK_API_KEY=your_clerk_api_key
    STRIPE_SECRET_KEY=your_stripe_secret_key
    NEON_DATABASE_URL=your_neon_database_url
    INNGEST_API_KEY=your_inngest_api_key
    OPENAI_API_KEY=your_openai_api_key
    
    
    
  5. Run the Application

    npm run dev
    
  6. Build for Production

    For deploying the app, build the project:

    npm run build
    

📚 Usage

  • User Registration: Sign up and log in securely using Clerk authentication.
  • Generate Study Material: Input topics or upload content to create AI-generated learning materials.
  • Payments: Subscribe to premium features using Stripe.
  • Real-Time Updates: Enjoy fast, responsive features powered by serverless functions.

🤝 Contribution

-We welcome contributions to make the AI Study Material Generator even better! Follow these steps to contribute:

  1. Fork the Project

    Create a copy of the repository by forking it. Create a Feature Branch

    git checkout -b feature/AmazingFeature
    
    
  2. Commit Your Changes

    git commit -m 'Add some AmazingFeature'
    
  3. Push to the Branch

    git push origin feature/AmazingFeature
    
    
  4. Open a Pull Request

    Submit your changes through a pull request for review.


📜 License

Distributed under the MIT License. See LICENSE for more details.

📞 Contact

Project Maintainer:


Feel free to reach out with any questions, ideas, or feedback!

About

AI Study Material Generator, a cutting-edge SaaS application designed to revolutionize learning by generating personalized study materials using advanced AI technology

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published