Quizard: chatGPT-generated quizzes on any just-about topic.
- AI-powered quiz generation
- Topic suggestions on your input
- Scoring and feedback
- Multiple choice questions
- Using your own API key
- Sharing quizzes
How to run the app locally:
-
openAI key: You need an openAI API key to generate quizzes and topic suggestions.
-
A Firebase project: Create a new firebase project, which offers Firestore database, which is used to store quiz data.
-
NodeJS >= v16: Install NodeJS locally using nvm.
- Clone the repo.
git clone https://github.com/DukeManh/quizard.git
- Copy the example environment file from
.env.example
to.env
.
cp .env.example .env
- Replace the environment variables with your own values.
OPENAI_API_KEY
: openAI API keyFB_*
: Firebase project config
- Install dependencies.
npm install -g pnpm
pnpm install
- Run the app.
pnpm dev
- Next.js: React framework for server-side rendered apps
- TypeScript: A typed superset of JavaScript
- Chakra UI: React component library
- chatGPT: chatGPT API using
gpt-3.5-turbo
model to generate quizzes - Firestore: Serverless NoSQL database for storing quiz data