Skip to content

ritz10001/team-gemini-final

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🧠 Quizlo.ai - AI-Powered Learning Platform

Transform any document into personalized, adaptive quizzes with AI-powered insights and study recommendations.

Quizlo.ai Next.js Node.js MongoDB Google Gemini

✨ Features

πŸš€ Core Functionality

  • πŸ“„ Smart Document Processing: Upload PDFs and automatically extract content with AI-powered chunking
  • πŸ€– AI Quiz Generation: Generate personalized quizzes using Google Gemini AI with adaptive difficulty
  • πŸ“Š Performance Analytics: Comprehensive analytics with AI recommendations and performance tracking
  • πŸ“š Study Reports: Personalized study guides with document references and external learning resources
  • 🎯 Adaptive Learning: Dynamic difficulty adjustment based on user performance

🎨 User Experience

  • πŸŒ™ Dark Theme: Beautiful, consistent dark theme throughout the application
  • πŸ“± Responsive Design: Works seamlessly on desktop, tablet, and mobile devices
  • ⚑ Real-time Feedback: Instant quiz results with detailed explanations
  • πŸ” ELI5 Explanations: Complex concepts explained in simple terms

πŸ“ˆ Advanced Analytics

  • 🎯 Performance Tracking: Track scores, timing, and improvement over time
  • πŸ—ΊοΈ Knowledge Heatmaps: Visual representation of topic mastery
  • πŸ€– AI Recommendations: Personalized study suggestions based on performance
  • πŸ“Š Mistake Analysis: Detailed breakdown of errors and learning opportunities

πŸ› οΈ Tech Stack

Frontend

  • Next.js 14 - React framework with App Router
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first CSS framework
  • Lucide React - Beautiful icons

Backend

  • Node.js - JavaScript runtime
  • Express.js - Web application framework
  • MongoDB Atlas - Cloud database
  • Mongoose - MongoDB object modeling

AI & Services

  • Google Gemini AI - Advanced language model for content generation
  • PDF Processing - Intelligent document parsing and chunking
  • Embedding Generation - Vector embeddings for content similarity

πŸš€ Quick Start

Prerequisites

  • Node.js 18+ installed
  • MongoDB Atlas account
  • Google Gemini API key

Installation

  1. Clone the repository
git clone https://github.com/Rajatjadhav10/quizlo.git
cd quizlo
  1. Install dependencies
# Install backend dependencies
cd backend
npm install

# Install frontend dependencies
cd ../frontend
npm install
  1. Environment Setup
# Backend environment
cd backend
cp .env.example .env
# Edit .env with your configuration

Required environment variables:

MONGODB_URI=your_mongodb_atlas_connection_string
GEMINI_API_KEY=your_google_gemini_api_key
PORT=3001
  1. Start the application
# Start backend server (from backend directory)
npm start

# Start frontend development server (from frontend directory)
npm run dev
  1. Access the application

πŸ“– Usage Guide

1. Upload Document

  • Navigate to the upload page
  • Select a PDF document
  • Wait for AI processing and content extraction

2. Generate Quiz

  • Choose your uploaded document
  • Select difficulty level and number of questions
  • Let AI generate personalized quiz questions

3. Take Quiz

  • Answer questions with real-time feedback
  • Get instant explanations for each answer
  • Use "Explain Like I'm 5" for complex topics

4. View Analytics

  • Check your performance dashboard
  • Review detailed analytics and AI recommendations
  • Track improvement over time

5. Study Reports

  • Generate personalized study guides
  • View document references with page numbers
  • Access curated external learning resources

πŸ—οΈ Project Structure

quizlo/
β”œβ”€β”€ backend/
β”‚   β”œβ”€β”€ config/          # Database and service configurations
β”‚   β”œβ”€β”€ models/          # MongoDB schemas
β”‚   β”œβ”€β”€ routes/          # API endpoints
β”‚   β”œβ”€β”€ services/        # Business logic and AI services
β”‚   └── server.js        # Express server setup
β”œβ”€β”€ frontend/
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ app/         # Next.js app router pages
β”‚   β”‚   └── components/  # Reusable React components
β”‚   └── public/          # Static assets
└── README.md

πŸ”§ API Endpoints

Documents

  • POST /api/documents/upload - Upload and process PDF
  • GET /api/documents/user/:userId - Get user documents

Quizzes

  • POST /api/quiz/generate - Generate AI quiz
  • POST /api/quiz/submit - Submit quiz answers
  • GET /api/quiz/result/:resultId - Get quiz results

Analytics

  • GET /api/analytics/user/:userId - User performance analytics
  • POST /api/analytics/study-guide - Generate study report
  • GET /api/analytics/advanced/:userId - Advanced analytics

🎯 Key Features Explained

AI Quiz Generation

  • Uses Google Gemini AI to analyze document content
  • Generates contextually relevant questions
  • Adapts difficulty based on user performance
  • Provides detailed explanations for each answer

Smart Study Reports

  • AI-powered personalized study guides
  • Document references with specific page numbers
  • Curated external learning resources
  • Actionable study plans and recommendations

Performance Analytics

  • Comprehensive performance tracking
  • AI-generated insights and recommendations
  • Visual knowledge heatmaps
  • Progress tracking over time

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

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

πŸ™ Acknowledgments

  • Google Gemini AI for powerful language model capabilities
  • MongoDB Atlas for reliable cloud database services
  • Next.js Team for the excellent React framework
  • Tailwind CSS for beautiful, utility-first styling

πŸ“ž Support

For support, email rajatjadhav10@example.com or create an issue in this repository.


Built with ❀️ by Rajat Jadhav

Transforming learning through AI-powered personalization

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors