GTA Backend

GTA's Python/Django API

A project built with the following languages and libs to design and expose the API for the GTA application.
python 3.8
django
django-ninja
postgresql
redis
django-channels
celery

Requirements

git, docker, and docker-compose.

Setup

1. Clone the project:

git clone https://github.com/3c-gg/reload-backend.git
cd reload-backend

2. Duplicate .template.env to .env and make sure you have all envvars set.
3. Run make up to get the project up and running.

Helper scripts

./pipenv-run is a helper command that wraps docker-compose to expose python-env-aware commands in a container. You can use it to run pipenv install or ./manage.py. See the Pipfile [scripts] section for additional commands.

On the Makefile there are some helper entrypoints that wrap the other wrappers.

Other instructions

• make up is a helper command that brings up the stack in docker compose, migrate db and load some starter data from from fixtures.
• ./pipenv-run test to run tests.
• ./pipenv-run lint to check if the code comply with the project's code rules.
• Access the api on http://localhost:8000 and the websocket on ws://localhost:8000.
• Admin credentials are admin@gta.com.br / adminadmin.
• If you're having permission issues, run make chown. That should set your user as the owner of project files.
• To add any new packages, run make pipinstall params={PACKAGE_NAME}. This will install the new package and restart the compose services.