Changed dependency management to poetry
This commit is contained in:
33
README.md
33
README.md
@ -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.
|
||||
|
||||
Reference in New Issue
Block a user