https://github.com/reznikovroman/financial-management-users
https://github.com/reznikovroman/financial-management-users
fastapi microservices postgresql sqlalchemy-orm
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/reznikovroman/financial-management-users
- Owner: ReznikovRoman
- Created: 2024-08-01T04:36:58.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T01:58:19.000Z (almost 2 years ago)
- Last Synced: 2025-06-27T10:43:56.774Z (about 1 year ago)
- Topics: fastapi, microservices, postgresql, sqlalchemy-orm
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# financial-management-users
... \# TODO: add description
## Stack
[FastAPI](https://fastapi.tiangolo.com/), [PostgreSQL](https://www.postgresql.org/)
## Services
- Financial Manager Users:
- ... \# TODO: add description
- https://github.com/ReznikovRoman/financial-management-users
- Financial Manager Accounts:
- ... \# TODO: add description
- https://github.com/ReznikovRoman/financial-management-accounts
- Financial Manager Notifications:
- ... \# TODO: add description
- https://github.com/ReznikovRoman/financial-management-notifications
## Configuration
Docker containers:
1. db
docker-compose files:
1. `docker-compose.yml` - for local development.
To run docker containers, you need to create a `.env` file in the root directory.
**`.env` example:**
```dotenv
ENV=.env
```
### Start project:
Locally:
```shell
docker compose build
docker compose up
```
## Development
Sync environment with `requirements.txt` / `requirements.dev.txt` (will install/update missing packages, remove redundant ones):
```shell
make sync-requirements
```
Compile requirements.\*.txt files (have to re-compile after changes in requirements.\*.in):
```shell
make compile-requirements
```
Use `requirements.local.in` for local dependencies; always specify _constraints files_ (-c ...)
Example:
```shell
# requirements.local.txt
-c requirements.txt
ipython
```
### Code style:
Configure pre-commit locally:
```shell
pre-commit install
```
Before pushing a commit run all linters:
```shell
make lint
```
Fix some mistakes:
```shell
make fix
```