Resource Management API

Resource management API made to practice creating automated tests, documentation with Swagger and Docker

Installation

1. After cloning the project, create an .env file from the .env-example file as well as add the missing environment variables (you can generate the SECRET_KEY through this website https://djecrety.ir/):

cp .env-example .env

2. Create and start the containers:

docker compose up -d --build

3. Run the tests and flake8 to see if everything is ok:

docker compose exec web bash "-c" "python manage.py test && flake8"

4. Create a super user:

docker compose exec web bash "-c" "python manage.py createsuperuser"

5. Test the installation by accessing the development server, API documentation is available at http://127.0.0.1:8000/documentation/.