https://github.com/jittojoseph/quizzlab
AI-Powered Dynamic Quiz Generator. Create personalized quizzes on any topic instantly.
https://github.com/jittojoseph/quizzlab
firebase gemini-api hackathon react
Last synced: 3 months ago
JSON representation
AI-Powered Dynamic Quiz Generator. Create personalized quizzes on any topic instantly.
- Host: GitHub
- URL: https://github.com/jittojoseph/quizzlab
- Owner: JittoJoseph
- License: apache-2.0
- Created: 2024-11-01T12:02:28.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T12:09:09.000Z (5 months ago)
- Last Synced: 2025-01-06T09:44:57.619Z (5 months ago)
- Topics: firebase, gemini-api, hackathon, react
- Language: JavaScript
- Homepage: https://quizzlab.vercel.app
- Size: 144 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QuizzLab 🎯
An AI-powered quiz generation platform that creates personalized learning experiences using Google's Gemini AI.
## Features
- **AI-Powered Quiz Generation**: Create custom quizzes on any topic instantly
- **Multiple Difficulty Levels**: Choose between Beginner, Intermediate, and Advanced
- **Real-time Feedback**: Get immediate feedback on your answers
- **Progress Tracking**: Track your learning journey with detailed statistics
- **User Profiles**: Save quiz history and view performance analytics
- **Responsive Design**: Seamless experience across all devices
## Tech Stack
- React 18 + Vite
- Firebase (Auth + Firestore)
- Google Gemini AI
- TailwindCSS
## Setup
### Prerequisites
- Node.js 16+ installed
- A Google Cloud account for Gemini API
- A Firebase account
### Installation Steps
1. Clone the repository
```bash
git clone https://github.com/JittoJoseph/QuizzLab.git
cd QuizzLab
```
2. Install dependencies
```bash
npm install
```
3. Firebase Setup
- Go to [Firebase Console](https://console.firebase.google.com)
- Create a new project
- Enable Authentication:
- Go to Authentication > Sign-in method
- Enable Google Sign-in
- Create Firestore Database:
- Go to Firestore Database
- Create database in test mode
- Get Firebase Config:
- Go to Project Settings > General
- Scroll to "Your apps"
- Click Web icon (>)
- Register app and copy config
4. Update Firebase Configuration
Replace the config in
firebase.js
:
```javascript
const firebaseConfig = {
apiKey: "your-api-key",
authDomain: "your-app.firebaseapp.com",
projectId: "your-project-id",
storageBucket: "your-app.appspot.com",
messagingSenderId: "your-sender-id",
appId: "your-app-id",
measurementId: "your-measurement-id"
};
```
5. Environment Setup
Create
.env
file in root directory:
```plaintext
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_GEMINI_API_KEY=your_gemini_api_key
```
6. Start Development Server
```bash
npm run dev
```
## Deployment
1. Push code to GitHub repository
2. Deploy on Vercel:
- Go to [vercel.com](https://vercel.com)
- Sign in with GitHub
- Import your repository
- Configure build settings:
- Framework Preset: Vite
- Build Command: npm run build
- Output Directory: dist
- Add environment variables
- Deploy!
## License
This project is licensed under Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
## Contact
Jitto Joseph - [@JittoJoseph50](https://x.com/JittoJoseph50)