Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 1.51 KB

README.md

File metadata and controls

62 lines (46 loc) · 1.51 KB
Raw

Backend

To run it, it's necessary to have Poetry installed. Then run,

poetry install

To configure the database connection, the Backend uses a DB_DEFAULT variable that must have a JSON string such as:

export DB_DEFAULT="{
    \"ENGINE\": \"${DB_DEFAULT_ENGINE:=django.db.backends.postgresql}\",
    \"NAME\": \"${DB_DEFAULT_NAME:=playground_kcidb}\",
    \"USER\": \"${DB_DEFAULT_USER:=<DB-USER>}\",
    \"PASSWORD\": \"<DB-PASSWORD>\",
    \"HOST\": \"${DB_DEFAULT_HOST:=127.0.0.1}\",
    \"PORT\": \"${DB_DEFAULT_PORT:=5432}\",
    \"CONN_MAX_AGE\": ${DB_DEAFULT_CONN_MAX_AGE:=null},
    \"OPTIONS\": {
      \"connect_timeout\": ${DB_DEFAULT_TIMEOUT:=2}
    }
}"

Attention to and placeholders

Finnaly execute the server with:

poetry run python3 manage.py runserver

Deploy instructions

To check if it is ready for a deploy you can run

poetry run python3 manage.py check --deploy

To generate a DJANGO_SECRET_KEY you can use

openssl rand -base64 22

or

export DJANGO_SECRET_KEY=$(openssl rand -base64 22)

We are not using sessions or anything like that right now, so changing the secret key won't be a big deal.

Requests

In the /requests directory we have scripts that execute requests to endpoints using httpie

Debug

For debugging we have two env variables

DEBUG and DEBUG_SQL_QUERY that can be set to True to enable debugging. The reason DEBUG_SQL_QUERY is separated is that it can be very verbose.