Quiz Api

📒 Index

• About
• Usage
• Developmen Environment
• File Structure
• Gallery
• Credit/Acknowledgment
• License

🔰 About

An API that helps you to host quizes online

• Question can be of types - MCQ and open text
• Question can have a text + image
• User can see list of quizzes (both live and past and upcoming)
• User can attempt quizzes

⚡ Usage

Register

Add Auth Token

Add Question

Host a quiz

Add id of questions in the questions list.

Live Quiz List

Get the list of live quizes

Past Quiz List

Get the list of past quizes

Upcoming Quiz List

Get the list of upcoming quiz

List of all the quizes

Get list of all the hosted quizes

Save score of the user

Get score of the user

Many more features

🔩 Development Environment

1. Clone the Repository

git clone https://github.com/nightwarriorftw/QuizApi.git
cd QuizApi

2. Install the virtual environment and activate it

python3 -m venv virtual
source ./virtual/bin/activate

3. Install the dependencies

pip install -r requirements.txt

4. Make migrations and run tests:

python manage.py makemigrations
python manage.py migrate

5. Run the project:

python manage.py runserver

📁 File Structure

├── accounts
│   ├── admin.py
│   ├── api
│   │   ├── serializers.py
│   │   ├── urls.py
│   │   └── views.py
│   ├── apps.py
│   ├── __init__.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── db.sqlite3
├── manage.py
├── quiz
│   ├── asgi.py
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── quizapp
│   ├── admin.py
│   ├── api
│   │   ├── __init__.py
│   │   ├── serializers.py
│   │   ├── urls.py
│   │   └── views.py
│   ├── apps.py
│   ├── __init__.py
│   ├── models.py
│   ├── tests.py
│   └── views.py
├── README.md
└── requirements.txt

🌟 Credits

Credit goes to the Author :-

• Aman Verma
• Github @nightwarriorftw
• Twitter @nightwarriorftw

🔒 License

LICENSE