Changed dependency management to poetry

This commit is contained in:
pptx704
2025-06-24 06:55:47 +03:00
parent 52aa93d67c
commit 90ae2ea8e4
17 changed files with 2034 additions and 54 deletions

View File

@ -21,3 +21,36 @@ Template repository for all FastAPI backend projects developed by Omukk.
git clone git@git.omukk.dev/<username>/<repo>.git
cd <repo>
```
## Development and Testing
1. **Install dependencies**:
```
poetry install
poetry run pre-commit install
```
2. **Run database server**:
```bash
docker compose up db -d
```
3. **Run Dev Server**:
```bash
poetry run fastapi dev
```
4. **Stop Database Server**:
```bash
docker compose down db
```
## Development Rules
- Create a separate branch from `dev` and create a PR to `dev` after making changes
- Branch names must be meaningful. Check [docs](https://docs.omukk.dev/doc/repos-bvFEDvytPz) for more details
- Always run `black` and `isort` to maintain code consistency (this is done automatically using pre-commit hooks)-
```bash
poetry run isort app main.py
poetry run black app main.py
# Make sure to run isort first
```
- Use static type checking using `mypy` if you feel like it (It is recommended but not mandatory). Static type checking might help you to identify critical bugs.