This is the repo for the MCQ Platform's server with Django as the framework and PostgreSQL as the database.
- PostgreSQL used as the primary database.
- Superuser is already initialized with the credentials: Username-
admin, Email-admin@admin.com, Password-admin - Integration with Django Rest Framework
- Integrated Djoser for user register/login/logout workflows.
- Used JWT for Authentication.
- API Documentation is configured using swagger.
- Containerized using Docker and managed using docker-compose.
To get a local copy of this template up and running on your machine, follow these simple steps.
- Docker
curl -fsSL https://get.docker.com -o get-docker.shsudo sh get-docker.shsudo apt install docker-composesudo groupadd dockersudo usermod -aG docker $USERnewgrp docker
- Clone the repo
git clone https://github.com/PICT-ACM-Student-Chapter/MCQ-Server.git - Change the current directory to the template
cd MCQ-Server - Build the docker containers
docker-compose -f docker-compose.dev.yml buildfor the dev containers anddocker-compose -f docker-compose.prod.yml buildfor the prod containers - Run the docker containers
docker-compose -f docker-compose.dev.yml upfor the dev containers anddocker-compose -f docker-compose.prod.yml upfor the prod containers
API documentation is done using swagger. Visit /swagger for API documentation.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Project Link: https://github.com/PICT-ACM-Student-Chapter/MCQ-Server