https://github.com/cognitive-engineering-lab/quizicist
AI-powered quiz generator
https://github.com/cognitive-engineering-lab/quizicist
Last synced: about 1 year ago
JSON representation
AI-powered quiz generator
- Host: GitHub
- URL: https://github.com/cognitive-engineering-lab/quizicist
- Owner: cognitive-engineering-lab
- Created: 2022-09-01T13:19:54.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T19:47:05.000Z (about 3 years ago)
- Last Synced: 2025-05-10T16:07:49.258Z (about 1 year ago)
- Language: Python
- Homepage: https://quizici.st
- Size: 6.53 MB
- Stars: 27
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Quizicist: an AI-powered quiz generator
## Getting started
Want to quickly generate a quiz? Visit our hosted Quizicist instance at [quizici.st](https://quizici.st). With a piece of text content (eg. a textbook or lecture notes), Quizicist can generate a quiz in minutes. Once you review the questions and mark answers as correct or incorrect, you can export the quiz to Google Forms, [mdbook-quiz](https://github.com/cognitive-engineering-lab/mdbook-quiz), or plain text.
## Running Quizicist locally
Running into rate limits at [quizici.st](https://quizici.st)? Quizicist can be deployed locally with the following instructions:
### Environment variables
You'll need to create a `.env` file in the root of the project with the following key-value pair:
```
OPENAI_SECRET_KEY=
```
### Dependencies
You'll also need to install dependencies:
```shell
$ cd lib && pip3 install -e . && cd ..
$ cd site && pip3 install -r requirements.txt
$ cd frontend && npm install --legacy-peer-deps
```
### Database
When developing/running locally, we use SQLite to store generated items:
```shell
$ cd site
$ python3 create_db.py # set up local sqlite database
```
### Running the server + frontend
In one shell:
```shell
$ cd site
$ flask --app backend/main --debug run --port 5000 # run server in debug mode
```
In another shell:
```shell
$ cd site/frontend && npm run dev -- --port 3000
```