Skip to content

blueedgetechno/quizmaster

Repository files navigation

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

Gallery

quiz1

quiz15

quiz2

Table of Contents

  1. Features
  2. Tools Used
  3. Installation
  4. Contributing
  5. 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:

    git clone https://github.com/blueedgetechno/quizmaster.git
    cd quizmaster
  2. Install dependencies:

    yarn install
  3. Make a .env.local file

    GEMINI_API_KEY=AIza...
    HUGGING_FACE_API_KEY=hf_...
    BING_API_KEY=8f9c...

    Gemini API Key: aistudio.google.com

    Hugging Face API Key: huggingface.co (Optional if you intend to use gemini only)

    Bing Api Key (Optional): Create an azure service

  4. Run:

    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 file for more information.