Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.95 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.95 KB
Raw

Quizmify - AI-Powered Quiz App

landingPage

Welcome to Quizmify, your ultimate destination for interactive quizzes on your favorite topics! Quizmify harnesses the power of AI to generate engaging quizzes tailored to your preferences. Whether you're a trivia enthusiast or simply curious about various subjects, Quizmify offers a personalized learning and entertainment experience.

Table of Contents

About Quizmify

Quizmify is a cutting-edge quiz application that leverages AI technology to provide dynamic quizzes based on your interests. You can customize the number and type of questions (Multiple Choice or Open-Ended) you want to tackle. After each quiz, Quizmify displays comprehensive statistics, including your answers, correct answers, accuracy, and time taken.

Each user has access to their quiz history, allowing them to track their progress and performance over time. Quizmify empowers you to engage with learning and fun simultaneously, making education enjoyable and interactive.

Features

  • AI-generated quizzes on a wide range of topics.
  • Customizable quiz parameters: choose question type and quantity.
  • Detailed post-quiz statistics, including accuracy and time taken.
  • Personal quiz history to track your progress.
  • User-friendly interface designed with Shadcn and Tailwind CSS.

Tech Stack

  • Next.js 13 - The frontend framework for building fast and dynamic web applications.
  • MySQL - A powerful open-source relational database.
  • Prisma - An efficient ORM (Object-Relational Mapping) tool for database management.
  • next-auth - A simple authentication library for Next.js applications.
  • Tailwind CSS - A utility-first CSS framework for rapid UI development.
  • OpenAI API - Harnessing AI for generating quiz questions.

Getting Started

To run Quizmify locally, follow these steps:

  1. Clone this repository: git clone https://github.com/mrswastik-robot/quizmify.git
  2. Navigate to the project directory: cd quizmify
  3. Install dependencies: npm install
  4. Set up environment variables:
    • Rename .env.example to .env and add your API keys and configuration.
  5. Run the application: npm run dev

For detailed instructions, refer to the Getting Started Guide.

Usage

  1. Visit the Quizmify website.
  2. Log in using your credentials or sign up for a new account.
  3. Choose your favorite topic and customize quiz parameters.
  4. Start the quiz and answer the questions.
  5. Review your post-quiz statistics and quiz history.

Contributing

We welcome contributions from the community! If you'd like to contribute to Quizmify.

License

This project is licensed under the MIT License.