From a86615f19c9dca07e1e90c07b67af268a49855cc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?E=CC=84riks=20K?= <git@72.lv>
Date: Sat, 5 Apr 2025 13:11:33 +0300
Subject: [PATCH] Create initial README file

---
 {{ cookiecutter.project_slug }}/README.md | 37 +++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 {{ cookiecutter.project_slug }}/README.md

diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md
new file mode 100644
index 0000000..ee40648
--- /dev/null
+++ b/{{ cookiecutter.project_slug }}/README.md	
@@ -0,0 +1,37 @@
+# Welcome to {{ cookiecutter.project_name }}
+
+## Setup
+### 1. Install dependencies
+#### Local virtual environment
+```shell
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements/local.txt
+```
+
+#### Docker image
+```shell
+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
+```shell
+aerich init-db
+```
+
+#### Migrate database
+```shell
+aerich upgrade
+```
+
+#### Create new database migration
+```shell
+aerich migrate
+```