https://github.com/blueedgetechno/quizmaster
Create Quiz on any topic with few clicks
https://github.com/blueedgetechno/quizmaster
ai generative-ai
Last synced: 7 months ago
JSON representation
Create Quiz on any topic with few clicks
- Host: GitHub
- URL: https://github.com/blueedgetechno/quizmaster
- Owner: blueedgetechno
- License: cc0-1.0
- Created: 2024-09-12T23:38:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-13T23:19:55.000Z (about 1 year ago)
- Last Synced: 2025-03-19T13:46:05.355Z (7 months ago)
- Topics: ai, generative-ai
- Language: TypeScript
- Homepage: https://quiz.blueedge.me
- Size: 1.21 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QuizMaster
QuizMaster is a web application that allows users to generate custom quizzes based on their prompts. Users can enter a prompt, select options (such as the number of questions, difficulty level, and topic), and QuizMaster will create a quiz for them.
Visit 💻✨: [quiz.blueedge.me](https://quiz.blueedge.me/)
## Gallery
## Table of Contents
1. [Features](#features)
2. [Tools Used](#tools-used)
3. [Installation](#installation)
4. [Contributing](#contributing)
5. [License](#license)
---
## Features
- **Prompt-based Quiz Generation:** Users can input any topic, and the app generates relevant quiz questions.
- **Customizable Options:** Users can set the number of questions, difficulty, and categories.
- **Real-time Results:** Users receive their scores and feedback immediately after submitting a quiz.
- **History and Stats:** Users can view previous quizzes and performance stats.
## Tools Used
- **Backend:** Next API
- **Frontend:** Next.js (v14), ui/shadcn
- **Styling:** CSS, Bootstrap (or Tailwind CSS)
- **External API:** Gemini API for prompt-based question generation, Bing Image Search API for images
- **Deployment:** Vercel
- **Telemetry:** Firebase, Sentry
## Installation
1. **Clone the repository:**
```bash
git clone https://github.com/blueedgetechno/quizmaster.git
cd quizmaster
```
2. **Install dependencies:**
```bash
yarn install
```
3. **Make a `.env.local` file**
```.env
GEMINI_API_KEY=AIza...
HUGGING_FACE_API_KEY=hf_...
BING_API_KEY=8f9c...
```
Gemini API Key: [aistudio.google.com](https://aistudio.google.com/app/apikey)
Hugging Face API Key: [huggingface.co](https://huggingface.co/settings/tokens) (Optional if you intend to use gemini only)
Bing Api Key (Optional): [Create an azure service](https://aka.ms/bingapisignup)
4. **Run:**
```bash
yarn dev
```
## Contributing
- Fork the repository.
- Create your feature branch (git checkout -b feature/NewFeature).
- Commit your changes (git commit -m 'Add new feature').
- Push to the branch (git push origin feature/NewFeature).
- Open a pull request.
## License
This project is licensed under the Creative Commons Zero License. See the [LICENSE](./LICENSE) file for more information.