GDC

quickstart - running locally

• create a virtual environment

python -m venv venv

if you are on windows, you need to allow the venv creation

Set-ExecutionPolicy AllSigned

• enter the virtual environment

linux:

source venv/bin/activate

windows:

.\venv\Scripts\activate

• installing dependencies

This command installs recursively all dependencies on the requirements file

pip install -r requirements.txt

• running migrations

This will create the database tables

python manage.py migrate

• running server

This command will run the server in http://localhost:8000/

python manage.py runserver

• routes documentation

If everything was set up correctly you will have two documentation routes

http://localhost:8000/api/docs/
http://localhost:8000/api/docs/swagger-ui/

The first one is a download of a yaml file and the second is the documentation ui.
The port may vary depending where the server is running. The default port is 8000.

Deploy links

• routes documentation

https://gdc-api.herokuapp.com/docs/redoc/
https://gdc-api.herokuapp.com/docs/swagger-ui/

• base url

https://gdc-api.herokuapp.com/api

• request example

https://gdc-api.herokuapp.com/api/login/