[TC-221]: init template-backend-service (#1)
https://eva.avroid.tech/desk/cards?obj=Task:TC-221 Начальная версия сервиса-шаблона Co-authored-by: Nadezhda <nadezhda.lavrentieva@avroid.team> Reviewed-on: https://git.avroid.tech/Templates/template-backend-service/pulls/1 Reviewed-by: Victor Stratov <victor.stratov@avroid.tech>
This commit is contained in:
35
README.md
35
README.md
@@ -1,2 +1,37 @@
|
||||
# template-backend-service
|
||||
|
||||
# Базовый шаблон для микросервисов в Avroid
|
||||
|
||||
|
||||
## TODO:
|
||||
- логирование
|
||||
- докеризация
|
||||
- кафка
|
||||
- sentry
|
||||
- миграции
|
||||
|
||||
# HOW TO
|
||||
|
||||
## Настроить pre-commit и запустить проект
|
||||
### !!! (поменяйте креды в local.env на свои личные)
|
||||
|
||||
```bash
|
||||
make setup
|
||||
make setup-pre-commit
|
||||
make start
|
||||
|
||||
```
|
||||
|
||||
## Запустить тесты:
|
||||
|
||||
Note: тесты запускаются в локальной БД на локальной машине!
|
||||
Перед запуском проверьте, что у вас есть указанный в `tests.conftest` юзер с нужным паролем (можно указать свой) и
|
||||
правами!
|
||||
|
||||
(И что в схеме public нет ничего нужного, потому что она дропается!)
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
|
||||
При локальном разворачивании документация доступна по адресу: http://0.0.0.0:8000/docs
|
||||
|
||||
Reference in New Issue
Block a user