Skip to content

Commit dbc1e83

Browse files
Update README.md
1 parent 20e6d2b commit dbc1e83

1 file changed

Lines changed: 90 additions & 1 deletion

File tree

README.md

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,90 @@
1-
ai-quiz-craft
1+
# AI Quiz Craft
2+
3+
Create engaging quizzes in seconds using the power of AI!
4+
**ai-quiz-craft** leverages the Gemini API to automatically generate custom quiz questions on any topic, providing a seamless and intelligent quiz creation experience.
5+
6+
---
7+
8+
## 🚀 Features
9+
10+
- **Gemini API-Powered Quiz Generation**
11+
Instantly generate high-quality quiz questions using Google’s Gemini AI API.
12+
- **Multiple Quiz Formats**
13+
Supports multiple-choice and true/false.
14+
- **Modern, Intuitive UI**
15+
Sleek, responsive design for a delightful user experience.
16+
- **TypeScript-first Codebase**
17+
Built for reliability, maintainability, and scalability.
18+
19+
---
20+
21+
## 🧠 How It Works
22+
23+
1. **Write Prompt**
24+
Enter a subject or prompt for your quiz.
25+
2. **Gemini API Generates Questions**
26+
The app sends your input to the Gemini API, which returns unique, relevant quiz questions and answers.
27+
---
28+
29+
## 🛠️ Tech Stack
30+
31+
- **Vite + React**
32+
- TypeScript
33+
- HTML & CSS
34+
- **Gemini API** for AI-powered content generation
35+
36+
---
37+
38+
## 📦 Installation
39+
40+
```bash
41+
git clone https://github.com/codewithsimon/ai-quiz-craft.git
42+
cd ai-quiz-craft
43+
npm install
44+
npm run dev
45+
```
46+
47+
---
48+
49+
## 🗝️ Gemini API Setup
50+
51+
To use the AI quiz generation feature, you’ll need a Gemini API key:
52+
53+
1. [Get your Gemini API key](https://ai.google.dev/)
54+
2. Add your API key to your environment variables or configuration file (see `.env.example` if available):
55+
56+
```env
57+
GEMINI_API_KEY=your_gemini_api_key_here
58+
```
59+
60+
---
61+
62+
## 💡 Usage
63+
64+
1. Start the app and open it in your browser.
65+
2. Enter your or prompt.
66+
3. Click "Generate Quiz"—the Gemini API will instantly generate questions and answers.
67+
4. Play your quiz and track your performance.
68+
69+
---
70+
71+
## 🤝 Contributing
72+
73+
Contributions are welcome!
74+
Please open an issue or pull request to discuss any changes.
75+
76+
---
77+
78+
## 📄 License
79+
80+
This project is licensed under the [MIT License](LICENSE).
81+
82+
---
83+
84+
## 🙋‍♂️ Questions?
85+
86+
Open an issue or reach out to [codewithsimon](https://github.com/codewithsimon).
87+
88+
---
89+
90+
Let me know if you want to add demo links, screenshots, or more instructions!

0 commit comments

Comments
 (0)