Stack used

Lint: Black

CI/CD: Github Actions

Authors

• @fandredev
• Alura

Installation:

First, clone this repository.

git clone [email protected]:fandredev/django-api-rest.git

Create virtual environment with Python

python -m venv venv

OR

python3 -m venv venv

Activate the virtual environment

source venv/bin/activate

Install dependencies using pip

pip install -r requirements.txt

• Look the .env.example file to change your informations from PostgreSQL database. A database must be created using PostgreSQL manually and your server needs be a running in other terminal.

In example, i use asdf to instance postgres in my machine. (https://asdf-vm.com/)

Run migrations to database

python manage.py migrate

Create a superuser

python manage.py createsuperuser

Run development server

python manage.py runserver

• or using launch.json file (if you use vscode)

Run tests

python manage.py test

Open Django Admin

In another tab, open browser and put http://localhost:8000/control in URL browser. Log in with your superuser

OPTIONAL (Populate your database using faker data)

python populate_students.py && python populate_courses.py

Use collection

Use DRF.postman_collection.json file to use Django Rest Framework routes

• Pass, the user and password authorization to using routes (super/password that were created with python manage.py createsuperuser)

• by default, the answers will come in .xml; Change this using 'Accept' header with 'application/json' value.

• Note: to use students routes v2 use, http://localhost:8000/students?version=v2

Feedback

If you have any feedback, please let us know via [email protected]

Referencies

• Django documentation
• Python
• Black formatter
• Alura Training