README.md

backend

• install

  pip install poetry # install poetry.
  poetry shell # activate virtual environment, if not already activated.
  poetry install # install dependencies.

• in config directory, create a .secrets.test.toml file and a .secrets.development.toml file with the following content:

  dynaconf_merge = true
  
  [MYSQL]
  username = "user"
  password = "password"

• Database Migration
  • login to the database container

    docker exec -it backend bash

  • create a new version

    alembic revision --autogenerate -m "create table"

  • upgrade the database

    alembic upgrade head # or alembic upgrade version_hash

  • downgrade the database

    alembic downgrade -1 # or alembic downgrade version_hash

• Optional step:

  pre-commit # install pre-commit hooks.
  choco install make # install make with admin privileges on Windows.