Ēriks K ef5da867a6 Improve template (#1)
- Created a README file
- Added PyCharm/IntelliJ IDE run configuration
- Squashed bugs related to:
  - Code style
  - Default Postgre database URL schema
- Updated project dependencies

Reviewed-on: #1
Co-authored-by: Ēriks K <git@72.lv>
Co-committed-by: Ēriks K <git@72.lv>
2025-04-05 13:15:41 +03:00

686 B

Welcome to {{ cookiecutter.project_name }}

Setup

1. Install dependencies

Local virtual environment

python3 -m venv venv
source venv/bin/activate
pip install -r requirements/local.txt

Docker image

docker build -f Dockerfile --tag {{ cookiecutter.project_slug }} .

2. Initial setup

Environment variables

Environment variables for the project are being read from the env.yml file:

  • Copy example yml:
    cp envs.example.yml envs.yml
  • Adjust values as necessary

Initialize database

aerich init-db

Migrate database

aerich upgrade

Create new database migration

aerich migrate