π AI Quiz Generator: Turn PDFs into Interactive Quizzes! π€π
Welcome to the AI Quiz Generator project, where learning meets innovation! This web application takes PDF documents and turns them into interactive multiple-choice quizzes. Test your knowledge on any topic with ease and get instant feedback on your score!
π Star this repo if you like it and follow for more cool projects!
β¨ Features
AI-Powered Quiz Generation: Upload a PDF, select a topic, and let the AI generate relevant quiz questions in seconds.
Interactive UI: Answer questions, get instant feedback, and track your progress.
Score Tracker: Get your final score after completing the quiz.
Built with FastAPI (Backend) & React (Frontend): A sleek combination of modern technologies.
TailwindCSS: Beautiful and responsive UI to ensure a smooth user experience.
π§ Technologies Used
Backend:
FastAPI: For serving APIs that manage PDF uploads and question generation.
Frontend:
React.js: For building a responsive and user-friendly quiz-taking interface.
TailwindCSS: For a modern, customizable UI design.
AI:
AI Model for Quiz Generation: Automatically generates MCQs based on topics in a PDF file.
Database: No database required for this projectβeverything is processed in real-time.
π How It Works
Upload Your PDF: Simply upload a PDF document containing the information you want to quiz on.
Select a Topic: Enter a topic (e.g., "IoT", "Machine Learning", etc.) to focus your quiz.
Start Quiz: The app generates relevant multiple-choice questions based on your document.
Answer Questions: As you progress through the quiz, answer the questions and see instant feedback on your answers.
Get Your Score: At the end of the quiz, see your final score and review your answers.
π Project Setup
π οΈ Backend (FastAPI)
Clone this repository:
git clone https://github.com/raunakwete43/quizcrafter.git cd quizcrafter
Install dependencies:
pip install -r backend/requirements.txt
Start the FastAPI server:
cd backend uvicorn main:app --reload
The backend will be running at http://localhost:8000.
π» Frontend (React)
Navigate to the frontend directory:
cd frontend
Install dependencies:
npm install
Start the Vite(React) development server:
npm run dev
The frontend will be running at http://localhost:3000.
π How to Use
Upload PDF: Go to the homepage and click on the "Upload PDF" button.
Enter a Topic: After uploading, type a topic (e.g., "Machine Learning") into the provided field.
Start the Quiz: Click "Start Quiz" and wait for the quiz to load.
Answer Questions: Choose your answers and move between questions using the "Back" and "Next" buttons.
Submit: Click "Submit" to see your final score.
π‘ Why Use This Project?
Effortless Learning: Automatically convert any PDF into a quiz with a single click.
Fast and Efficient: The AI quickly generates multiple-choice questions, saving you time.
Perfect for Students & Educators: Turn any document into an interactive learning tool.
Beautiful UI: The appβs UI is built with React and TailwindCSS, ensuring a smooth and delightful experience.
π― Contributing
We welcome contributions to make this project better! If youβd like to contribute, follow these steps:
Fork the repo.
Clone your fork: git clone https://github.com/raunakwete43/quizcrafter
Make your changes and create a pull request with a detailed description of your contribution.
β οΈ NOTE
If you are hosting the backend and frontend separately or on different domains, ensure the frontend API requests point to the correct backend URL (for example, replace http://localhost:8000 with your hosted backend URL). This is important to ensure proper communication between the two components.
π Support the Project
If you find this project useful, give it a βοΈ and follow for more cool open-source projects!
π License
This project is licensed under the MIT License - see the LICENSE file for details.