An open API service indexing awesome lists of open source software.

https://github.com/ankulmaurya88/django-quiz-app

A web-based quiz platform with user login, timed questions, auto scoring, and an admin panel โ€” built using Django.
https://github.com/ankulmaurya88/django-quiz-app

django-rest-framework docker docker-compose python3 quiz-application shell-script web-app-education-online-exam

Last synced: 3 months ago
JSON representation

A web-based quiz platform with user login, timed questions, auto scoring, and an admin panel โ€” built using Django.

Awesome Lists containing this project

README

          

# ๐Ÿง  Django Quiz App

The **Django Quiz App** is a web-based quiz platform where users can take quizzes, track their scores, and review results. It features a clean UI, user authentication, and admin controls for quiz management. Built using Django and designed with Docker for easy deployment.

๐Ÿ“Œ **GitHub Repository**
โžก๏ธ [https://github.com/ankulmaurya88/Django-Quiz-App.git](https://github.com/ankulmaurya88/Django-Quiz-App.git)

---

## ๐Ÿ“Œ Table of Contents

- [โœจ Features](#-features)
- [๐Ÿ“ธ Screenshots](#-screenshots)
- [๐Ÿงช Input & Output](#-input--output)
- [๐Ÿงฐ Technologies Used](#-technologies-used)
- [๐Ÿ“ Project Structure](#-project-structure)
- [โš™๏ธ Installation Guide](#๏ธ-installation-guide)
- [๐Ÿณ Docker Deployment](#-docker-deployment)
- [๐Ÿš€ Usage](#-usage)
- [๐Ÿ“„ License](#-license)
- [๐Ÿ‘ค Author](#-author)

---

## โœจ Features

โœ… User Registration and Login
โœ… Multiple Quizzes with Timer and Scoring
โœ… Admin Panel for Quiz Management
โœ… Real-Time Score Tracking
โœ… Responsive and Minimal UI
โœ… Docker Support for Easy Deployment

---

## ๐Ÿ“ธ Screenshots

### ๐Ÿ”น Login Page
User authentication for secure access.
![Login Page](assets/login.png)

---

### ๐Ÿ”น Quiz Interface
Display questions one by one, timer-based interface.
![Quiz Interface](assets/quiz.png)

---

### ๐Ÿ”น Score Page
Results displayed after quiz completion with user score.
![Score Page](assets/score.png)

### ๐Ÿ”น Admin Page
Display Admin Panel.
![Admin Page](assets/admin.png)

---

## ๐Ÿงช Input & Output

### ๐Ÿ“ Input:
User logs in or signs up and selects a quiz to begin. Each quiz contains multiple-choice questions.

### ๐Ÿ“ค Output:
After quiz submission, the user sees:

| Field | Description |
|---------------|------------------------------|
| Quiz Title | The name of the quiz taken |
| User Score | Total correct answers scored |
| Total Marks | Total number of questions |
| Time Taken | Time spent on the quiz |

---

## ๐Ÿงฐ Technologies Used

| Area | Tools and Frameworks |
|-------------|----------------------------------|
| Language | Python 3.8+ |
| Backend | Django |
| Database | SQLite (default), MySql |
| Frontend | HTML, CSS, Bootstrap |
| Deployment | Docker, Docker Compose |
| Web Server | Nginx (optional) |

---

## ๐Ÿ“ Project Structure
Django-Quiz-App/ โ”œโ”€โ”€ manage.py โ”œโ”€โ”€ quiz/ # Main quiz app โ”‚ โ”œโ”€โ”€ admin.py โ”‚ โ”œโ”€โ”€ models.py โ”‚ โ”œโ”€โ”€ views.py โ”‚ โ”œโ”€โ”€ urls.py โ”‚ โ””โ”€โ”€ templates/ โ”œโ”€โ”€ users/ # User management โ”œโ”€โ”€ static/ # Static files โ”œโ”€โ”€ templates/ # Base templates โ”œโ”€โ”€ Dockerfile โ”œโ”€โ”€ docker-compose.yml โ””โ”€โ”€ requirements.txt

---

## โš™๏ธ Installation Guide

### ๐Ÿ”ง Prerequisites

- Python 3.8+
- Git
- Virtual Environment (optional but recommended)

### ๐Ÿ› ๏ธ Steps

```bash
# Clone the repository
git clone https://github.com/ankulmaurya88/Django-Quiz-App.git
cd Django-Quiz-App

# (Optional) Create and activate a virtual environment
python3 -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate

# Install Python dependencies
pip install -r requirements.txt

# Run migrations
python manage.py migrate

# Create a superuser for admin access
python manage.py createsuperuser

# Run the development server
python manage.py runserver
```
---

## ๐Ÿณ Docker Deployment

---
```bash
# Clone the repo
git clone https://github.com/ankulmaurya88/Django-Quiz-App.git
cd Django-Quiz-App

# Build and deploy with Docker Compose
docker-compose up --build
```
---
### ๐Ÿš€ Usage
Open the app in your browser: http://localhost:8000

Register or login as a user

Choose a quiz and start answering questions

Submit the quiz and view your score
Admins can manage quizzes via the Django admin panel at http://localhost:8000/admin/

---
### ๐Ÿ“„ License
This project is licensed under the MIT License โ€“ see the LICENSE file for details.

---
### ๐Ÿ‘ค Author
Ankul Maurya

GitHub: @ankulmaurya88

LinkedIn: linkedin.com/in/ankulmaurya