SmartQuiz REST API

Welcome to SmartQuiz! This application is designed to manage users, categories, questions, and quizzes. It provides functionality for Super Admins, Admins, and Players. Developed with Python and Flask, the application follows clean code principles, adhering to SOLID principles and object-oriented programming (OOPs) practices. Unit testing is implemented using pytest to ensure robust functionality. This application was created during the internship at WatchGuard, Noida.

Consider using pipenv to manage your project dependencies.

Getting Started

Before running the application, make sure you have created a .env file in the project root directory with the following credentials for the Super Admin:

SUPER_ADMIN_NAME=YourSuperAdminName
SUPER_ADMIN_EMAIL=YourSuperAdminEmail
SUPER_ADMIN_USERNAME=YourSuperAdminUsername
SUPER_ADMIN_PASSWORD=YourSuperAdminPassword
MYSQL_USER=YourMySQLusername
MYSQL_PASSWORD=YourMySQLpassword
MYSQL_HOST=YourMySQLhost
MYSQL_DB=YourMySQLdb
JWT_SECRET_KEY=YourSecretKey
SUPER_ADMIN_MAPPING=YourSuperAdminMapping
ADMIN_MAPPING=YourAdminMapping
PLAYER_MAPPING=YourPlayerMapping
LOG_TAIL_TOKEN=YourSourceToken

Prerequisites

• Python
• Pipenv
• MySQL database

Installation

1. Clone this repository:

https://github.com/Shreyansh-Agrawal/QuizApplication.git

2. Navigate to the project directory:

cd QuizApplication

3. Install project dependencies using pipenv:

pipenv install

or

python -m pipenv install

Run the Application

To run the application, use the following command:

cd .\src\
python -m flask --app server run --debug

Run the Tests

The application includes unit testing implemented using pytest. To run the Tests, use the following command:

pipenv shell
pytest

Project Structure

QuizApplication/
├── docs/
│   ├── API Endpoint Specification.pdf
│   ├── QuizApplication.postman_collection.json
│   ├── Requirements and Design Specification.pdf
├── src/
│   ├── business/
│   │   ├── auth_business.py
│   │   ├── category_business.py
│   │   ├── question_business.py
│   │   ├── quiz_business.py
│   │   ├── user_business.py
│   ├── config/
│   │   ├── flask_configs.py
│   │   ├── initialize_app.py
│   │   ├── log_configs.py
│   │   ├── queries.py
│   │   ├── quiz_data.json
│   │   ├── regex_patterns.py
│   │   ├── string_constants.py
│   ├── controllers/
│   │   ├── auth_controller.py
│   │   ├── category_controller.py
│   │   ├── question_controller.py
│   │   ├── quiz_controller.py
│   │   ├── user_controller.py
│   ├── database/
│   │   ├── database_access.py
│   │   ├── database_connection.py
│   ├── models/
│   │   ├── quiz/
│   │   │   ├── category.py
│   │   │   ├── option.py
│   │   │   ├── question.py
│   │   │   ├── quiz_entity.py
│   │   ├── users/
│   │   │   ├── admin.py
│   │   │   ├── player.py
│   │   │   ├── super_admin.py
│   │   │   ├── user.py
│   ├── routes/
│   │   ├── auth_routes.py
│   │   ├── category_routes.py
│   │   ├── question_routes.py
│   │   ├── quiz_routes.py
│   │   ├── user_routes.py
│   ├── schemas/
│   │   ├── auth.py
│   │   ├── category.py
│   │   ├── config_schema.py
│   │   ├── question.py
│   │   ├── quiz.py
│   │   ├── user.py
│   ├── utils/
│   │   ├── custom_error.py
│   │   ├── custom_response.py
│   │   ├── error_handlers.py
│   │   ├── id_generator.py
│   │   ├── password_generator.py
│   │   ├── password_hasher.py
│   │   ├── rbac.py
│   ├── requirements.txt
│   ├── server.py
├── tests/...
├── .env.example
├── .gitignore
├── Pipfile
├── Pipfile.lock
├── pytest.ini
├── README.md

Database

The application employs an MySQL database with the following tables:

• Users: Stores user information.
• Credentials: Stores user credentials for authentication.
• Scores: Stores player scores.
• Categories: Stores quiz categories.
• Questions: Stores quiz questions.
• Options: Stores options for quiz questions.

Usage

Super Admin

• Create Admin Account: Create new admin accounts.
• View Admins: View a list of admins.
• Delete Admin Details: Delete admin accounts.

Admin

• Manage Players: View player data and delete player accounts.
• Manage Quizzes: Add, update, and delete quiz categories and questions. View existing categories and questions.

Player

• Take a Quiz: Participate in quizzes by selecting a category or can play a random quiz.
• View Leaderboard: View the quiz leaderboard.
• View Your Scores: View their own past quiz scores.

Feel free to explore the project, and don't forget to set up your environment and database before running the application.