Skip to content
Sree24-uiPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

EduQuiz AI - AI-Powered Quiz Generator

A modern, interactive web application that generates quizzes and flashcards from PDFs or text using AI.

🚀 Quick Start

New to this? Start here:

  1. ⚡ QUICK_START.md - Get running in 5 minutes! (Recommended for beginners)
  2. 📚 SETUP_GUIDE.md - Detailed step-by-step instructions with examples
  3. 💻 TERMINAL_EXAMPLES.md - Copy & paste terminal commands with examples

Features

  • 📄 PDF Upload: Extract text from PDFs to generate quizzes
  • 🤖 AI-Powered Quiz Generation: Create custom quizzes with multiple difficulty levels
  • 📚 Flashcards: Generate interactive flashcards for studying
  • 📊 Performance Analytics: Track your quiz performance with charts
  • 💬 AI Chat Assistant: Ask questions about your study material
  • 🎨 Modern UI: Smooth animations and transitions
  • 📱 Responsive Design: Works on desktop and mobile

Setup Instructions

1. Install Dependencies

npm install

2. Start the Server

The application requires a Python server to proxy API requests (avoids CORS issues):

python3 server.py

The server will start on http://localhost:8080

3. Open the Application

Open index.html in your browser, or navigate to:

  • http://localhost:8080/index.html (Landing page)
  • http://localhost:8080/auth.html (Login page)
  • http://localhost:8080/app.html (Main application)

4. Configure API Key

  1. Get a free API key from OpenRouter
  2. Click on "API Key" in the sidebar
  3. Enter your OpenRouter API key
  4. Click "Save & Continue"

Usage

Generating a Quiz

  1. Navigate to AI Studio from the sidebar
  2. Either:
    • Upload a PDF file, OR
    • Paste text into the text area
  3. Select difficulty level (Easy/Medium/Hard)
  4. Choose number of questions (5, 10, 15, or Auto)
  5. Click Generate Quiz

Creating Flashcards

  1. Upload a PDF or enter text
  2. Click Generate Flashcards
  3. Use arrow keys or buttons to navigate
  4. Click cards to flip them
  5. Press 'R' to hear text-to-speech

Taking a Quiz

  • Click on answer options to select
  • Use number keys (1-4) for quick selection
  • Progress bar shows your completion
  • Results are shown at the end with detailed analysis

Keyboard Shortcuts

  • Flashcards:

    • Space: Flip card
    • ← →: Navigate cards
    • R: Read current card (text-to-speech)
    • Escape: Close and return to dashboard
  • Quiz:

    • 1-4: Select answer option
    • Escape: Return to dashboard

Troubleshooting

API Not Working

  • Ensure the Python server is running: python3 server.py
  • Check that your OpenRouter API key is valid
  • Verify the server is on port 8080

Quiz Not Generating

  • Make sure you have entered text or uploaded a PDF
  • Check your API key is set correctly
  • Ensure the Python server is running
  • Check browser console for error messages

Server Errors

If you see network errors:

  1. Make sure server.py is running
  2. Check that port 8080 is not in use
  3. Verify Python 3 is installed: python3 --version

Project Structure

project/
├── index.html          # Landing page
├── auth.html           # Login page
├── app.html            # Main application
├── server.py           # Python proxy server
├── styles.css          # Global styles
├── js/
│   ├── config.js       # Firebase & API config
│   ├── ai.js           # AI quiz generation logic
│   ├── ui.js           # UI interactions & routing
│   └── pdf-handler.js  # PDF text extraction
└── package.json        # Dependencies

Technologies Used

  • Frontend: HTML5, CSS3, JavaScript (ES6+)
  • Styling: Tailwind CSS
  • AI: OpenRouter API (Mistral 7B)
  • PDF Processing: PDF.js
  • Charts: Chart.js
  • Backend: Python HTTP Server

License

This project is for educational purposes.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages