Files
template-backend-service/README.md
Nadezhda Lavrentieva a4b2c99c25 [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>
2024-10-15 10:22:28 +03:00

38 lines
1.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 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