Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ak4m410x01/examination_platform_api
ExamSandbox is a secure examination platform using Docker for isolated code execution. Ideal for educational assessments, it offers a user-friendly interface, robust security measures, and detailed result evaluations.
https://github.com/ak4m410x01/examination_platform_api
django django-rest-framework docker docker-compose examination-system exams-management-system postgresql python rest-api university
Last synced: about 1 month ago
JSON representation
ExamSandbox is a secure examination platform using Docker for isolated code execution. Ideal for educational assessments, it offers a user-friendly interface, robust security measures, and detailed result evaluations.
- Host: GitHub
- URL: https://github.com/ak4m410x01/examination_platform_api
- Owner: ak4m410x01
- License: gpl-3.0
- Created: 2024-01-21T12:59:26.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-09T19:36:39.000Z (7 months ago)
- Last Synced: 2024-07-21T20:02:21.080Z (5 months ago)
- Topics: django, django-rest-framework, docker, docker-compose, examination-system, exams-management-system, postgresql, python, rest-api, university
- Language: Python
- Homepage:
- Size: 2.06 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Examination Platform API
## Details
The Examination Platform is a robust system for efficient exam management within educational institutions. It features distinct user roles - administrators, instructors, and students. The platform ensures secure authentication, comprehensive user data management, and effective exam handling. With an intuitive interface, it prioritizes user-friendly design and scalability to accommodate growth. Results access control is implemented, and considerations include audit trails, notifications, and data integrity. The platform aims to streamline examination processes, providing a reliable and user-centric solution.
## ⚙ Tools and Technologies used
1. **[Python](https://www.python.org/)**: Primary programming language chosen for its simplicity, readability, and vast ecosystem of libraries and frameworks.
2. **[Django](https://www.djangoproject.com/)**: A high-level Python web framework renowned for its scalability, security features, and rapid development capabilities.
3. **[Django Rest Framework (DRF)](https://www.django-rest-framework.org/)**: Built on top of Django, DRF provides powerful tools for building RESTful APIs, simplifying the creation of web services.
4. **[PostgreSQL](https://www.postgresql.org/)**: A robust open-source relational database management system known for its reliability, extensibility, and support for complex queries and transactions.
5. **[JWT (JSON Web Tokens)](https://django-rest-framework-simplejwt.readthedocs.io/en/latest/)**: A standard for securely transmitting information between parties as JSON objects, commonly used for authentication and authorization in web applications.
6. **[Docker](https://www.docker.com/)**: Containerization platform that simplifies the deployment and management of applications by packaging them into portable containers, ensuring consistency across different environments.
7. **[Docker Compose](https://docs.docker.com/compose/)**: Tool for defining and running multi-container Docker applications, enabling seamless configuration and orchestration of complex application architectures.
## 🛠 Installation and setup
1. Install Docker [here](https://www.docker.com/get-started/)
2. Install Git [here](https://git-scm.com/downloads)
3. Create a working directory:
```bash
mkdir ~/MAAT && cd ~/MAAT
```
4. Clone the repository
```bash
git clone https://github.com/ak4m410x01/Examination_Platform_API.git .
```
5. Switch to DeployOnDocker Branch
```bash
git switch DeployOnDocker
```
6. Start the application
```bash
docker-compose up -d
```
7. Access API: http://127.0.0.1/api/
8. Access DB: 127.0.0.1:5432
9. Don't forget .env file with variables
| Variable | Value |
| ----------------- | --------------------------------------------------------------------- |
| SECRET_KEY | 'django-insecure-%2dmqnqj9v2e&8yk\*t=#b+2-=i!45+153*@-g0*=&%1od16z^m' |
| DEBUG | False |
| ALLOWED_HOSTS | 172.0.0.1,* |
| DATABASE_ENGINE | django.db.backends.postgresql |
| DATABASE_HOST | postgres |
| DATABASE_PORT | 5432 |
| DATABASE_NAME | maat |
| DATABASE_USER | maat |
| DATABASE_PASSWORD | maat |
| JWT_SECRET_KEY | JWT_S3CR3T_K3Y |
| POSTGRES_DB | maat |
| POSTGRES_USER | maat |
| POSTGRES_PASSWORD | maat |
note:
these variables are for the lab environment only... don't use these in xxx production environments xxx
---
## 🛠 Documentation and Endpoints
1. [Postman](https://documenter.getpostman.com/view/27192844/2sA2xnxA2s)
2. [Apidog](https://wwulj09fuf.apidog.io)
---
## PIP Packages
+-------------------------------+---------+---------------------------+
| Name | Version | Use |
| ----------------------------- | ------- | ------------------------- |
| Python | 3.11.7 | Programming Lang |
| Django | 5.0.2 | Django Framework |
| djangorestframework | 3.14.0 | Restful Framework |
| djangorestframework-simplejwt | 5.3.1 | Restful Framework Jwt |
| django-filter | 23.5 | Restful Framework filters |
| django-cors-headers | 4.3.1 | Restful Framework CORS |
| psycopg2-binary | 2.9.9 | PostgreSQL DB lib |
| pthon-decouple | 3.8 | To use .env file |
+-------------------------------+---------+---------------------------+