Skip to content

nitesh2920/PrepSphere-AI

Repository files navigation

🧡 PrepSphere AI - Smart Study Companions

PrepSphere AI Logo

AI-Powered Study Material Generator

Next.js TypeScript Tailwind CSS Vercel

🚀 Live Demo🐛 Report Bug✨ Request Feature


🌟 What is PrepSphere AI?

PrepSphere AI is a study companion that transforms the way students, professionals to prepare for exams , interviews or to learn any topic. Using advanced AI technology, it generates personalized study materials including comprehensive notes, interactive flashcards, and challenging quizzes tailored to your learning needs.

Key Features

🤖 AI-Powered Content Generation

  • Generate comprehensive study notes from any topic
  • Create interactive flashcards for active recall
  • Build challenging quizzes with detailed explanations
  • Personalized content based on difficulty level

💳 Smart Credit System

  • Basic Plan: 5 free credits monthly
  • Pro Plan: 50 credits for ₹199/month
  • 1 credit = 1 complete course package (notes + flashcards + quiz)

🎨 Beautiful User Experience

  • Modern, responsive design with dark/light mode
  • Mobile-first approach with PWA support
  • Intuitive navigation and user-friendly interface

🚀 Quick Start

Prerequisites

  • Node.js 18+ installed
  • npm or yarn package manager
  • Git for version control

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/prepsphere-ai.git
    cd prepsphere-ai
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Set up environment variables

    cp .env.example .env.local

    Fill in your environment variables:

    # Clerk Authentication
    NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
    CLERK_SECRET_KEY=your_clerk_secret_key
    
    # Database
    DATABASE_URL=your_neon_database_url
    
    # Google AI
    GOOGLE_AI_API_KEY=your_google_ai_api_key
    
    # Stripe Payments
    STRIPE_SECRET_KEY=your_stripe_secret_key
    NEXT_PUBLIC_STRIPE_MONTHLY_PRICE_ID=your_stripe_price_id
    
    # Inngest
    INNGEST_EVENT_KEY=your_inngest_event_key
    INNGEST_SIGNING_KEY=your_inngest_signing_key
  4. Run the development server

    npm run dev
    # or
    yarn dev
  5. Open your browser Navigate to http://localhost:3000


📁 Project Structure

prepsphere-ai/
├── 📁 app/                          # Next.js App Router
│   ├── 📁 _components/              # Reusable components

│   │   └── 📁 landing/              # Landing page sections
│   ├── 📁 _context/                 # React context providers
│   ├── 📁 _hooks/                   # Custom React hooks
│   ├── 📁 api/                      # API routes
│   ├── 📁 course/                   # Course-related pages
│   ├── 📁 dashboard/                # Dashboard and user pages
│   └── 📁 create/                   # Course creation flow
├── 📁 components/                   # UI components
├── 📁 configs/                      # Configuration files
├── 📁 inngest/                      # Background job functions
├── 📁 public/                       # Static assets
├── 📄 Dockerfile                    # Docker configuration
├── 📄 docker-compose.yml           # Docker Compose setup
└── 📄 README.md                     # This file

🐳 Docker Deployment

see reference here

🤝 Contributing

We welcome contributions! Here's how you can help:

Development Setup

  1. Fork the repository
  2. Create a feature branch
    git checkout -b feature/amazing-feature
  3. Make your changes
  4. Run tests and linting
    npm run lint
    npm run type-check
  5. Commit your changes
    git commit -m 'Add amazing feature'
  6. Push to your branch
    git push origin feature/amazing-feature
  7. Open a Pull Request

Contribution Guidelines

  • Follow the existing code style and conventions
  • Write clear, descriptive commit messages
  • Add tests for new features
  • Update documentation as needed
  • Ensure all checks pass before submitting PR

Performance Monitoring

  • Vercel Analytics integration
  • Real User Monitoring (RUM)
  • Error tracking with Sentry (optional)

Upcoming Features

  • Advanced AI Models: GPT-4 and Claude integration
  • Collaboration: Share courses with classmates
  • Analytics: Detailed study analytics and insights

Made with ❤️ by the PrepSphere Team

🌐 Website🐦 Twitter📧 Email

Star this repo if you found it helpful!

About

PrepSphere AI is a study companion that transforms the way students, professionals to prepare for exams , interviews or to learn any topic. Using advanced AI technology, it generates personalized study materials including comprehensive notes, interactive flashcards, and challenging quizzes tailored to your learning needs.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages