GradeX is an intelligent web application designed to revolutionize how students and educators prepare for and create exams. By harnessing the power of generative AI, it automates the creation of high-quality, customized question papers based on specific curriculum requirements. This tool saves valuable time for educators and provides students with a powerful resource for targeted revision.
- 🧠 Intelligent Content Generation: Leverages advanced AI to generate questions and answers that are contextually relevant and accurate.
- 📚 Curriculum-Specific: Tailor question papers by selecting the class, subject, and specific chapters.
- 📝 Customizable Question Types: Choose from a variety of question formats (MCQ, Short Answer, True/False, etc.) and set the desired quantity for each.
- 💻 Modern & Interactive UI: A clean, responsive, and user-friendly interface built with the latest web technologies for a seamless experience.
- 📄 PDF Export: Instantly download the generated question papers as a PDF, with the option to include or exclude the answer key.
- ✅ Review & Confirm: A final confirmation step allows users to review their selections before the AI begins the generation process.
- 🌙 Dark Mode: A sleek and comfortable dark mode for reduced eye strain during late-night study sessions.
| Landing Page | Generation Form |
|---|---|
 |
 |
| Review Dialog | Generated Questions |
|---|---|
 |
 |
Using GradeX is as simple as 1-2-3:
- Select Your Material: Navigate to the "Generate" page and choose the desired class and subject from the dropdown menus.
- Choose Your Chapters & Questions: Select one or more chapters you want to focus on. Then, specify the types of questions (e.g., MCQs, Short Answer) and the number you need for each.
- Generate & Download: Review your selections in the confirmation dialog. Once confirmed, the AI will generate your unique question paper, which you can immediately view and download as a PDF.
- Framework: Next.js 16 (with App Router)
- Language: TypeScript
- AI Integration: Genkit (Google's Generative AI Toolkit) & Gemini
- Backend & Auth: Firebase (Authentication & Cloud Firestore)
- Styling: Tailwind CSS
- UI Components: Shadcn/UI
- Animations: Framer Motion
- Form Management: React Hook Form
- Schema Validation: Zod
- PDF Generation: jsPDF
Follow these steps to get the project running on your local machine.
-
Clone the repository:
git clone https://github.com/AadityaGeek/GradeX.git cd GradeX -
Install dependencies:
npm install
-
Set up environment variables: Create a
.envfile in the root of your project and add your Google AI API key.GEMINI_API_KEY="YOUR_API_KEY_HERE" GENERATE_QUESTIONS_PROMPT="YOUR_CUSTOM_PROMPT"
This project requires two services to be running concurrently: the Next.js frontend and the Genkit AI service.
-
Start the Next.js development server:
npm run dev
This will start the application on
http://localhost:9002. -
Start the Genkit development service (in a separate terminal):
npm run genkit:dev
This runs the Genkit flows in development mode and allows the frontend to communicate with the AI backend.
Now you can open your browser and navigate to http://localhost:9002 to use the application.
Contributions are welcome! If you have suggestions for improvements, please feel free to create an issue or submit a pull request.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is distributed under the MIT License. See LICENSE for more information.