ac441a108b
https://eva.avroid.tech/desk/Task/TC-642#be-dorabotat-shablon-servisov-backend Дорабатываем шаблон сервисов по требованиям: https://eva.avroid.tech/project/Document/DOC-002710#trebovanija-k-versijam Reviewed-on: https://git.avroid.tech/Templates/template-backend-service/pulls/3 Reviewed-by: Victor Stratov <victor.stratov@avroid.team> Reviewed-by: Petr Brovchenko <petr.brovchenko@avroid.team> Co-authored-by: Nadezhda <nadezhda.lavrentieva@avroid.team> Co-committed-by: Nadezhda <nadezhda.lavrentieva@avroid.team>
74 lines
1.8 KiB
Markdown
74 lines
1.8 KiB
Markdown
# template-backend-service
|
||
|
||
# Базовый шаблон для микросервисов в Avroid
|
||
|
||
|
||
## TODO:
|
||
- логирование
|
||
- докеризация
|
||
- кафка
|
||
- sentry
|
||
- миграции
|
||
|
||
# HOW TO
|
||
|
||
|
||
## Настроить pre-commit и запустить проект
|
||
### !!! (поменяйте креды в local.env на свои личные)
|
||
|
||
```bash
|
||
$ make setup
|
||
$ make setup-pre-commit
|
||
$ make start
|
||
```
|
||
|
||
## Запустить тесты:
|
||
|
||
Note: тесты запускаются в локальной БД на локальной машине!
|
||
Перед запуском проверьте, что у вас есть указанный в `tests.fixtures.db` юзер с нужным паролем (можно указать свой) и
|
||
правами!
|
||
|
||
(И что в схеме public нет ничего нужного, потому что она дропается!)
|
||
|
||
```bash
|
||
$ make test
|
||
```
|
||
|
||
При локальном разворачивании документация доступна по адресу: http://localhost:8000/docs
|
||
|
||
## Проверить работоспособность сервиса
|
||
|
||
Простая healthcheck-проверка:
|
||
|
||
```bash
|
||
$ curl -s -o /dev/null -w "%{http_code}" http://localhost:8000/api/_/healthcheck
|
||
```
|
||
|
||
Ожидаем увидеть код ответа: `200`.
|
||
|
||
## Работа с миграциями
|
||
|
||
### Создать/сгенерировать миграции
|
||
|
||
```bash
|
||
COMMENT="short human readable comment" make create-migrations
|
||
```
|
||
|
||
### Применить миграции
|
||
|
||
```bash
|
||
make apply-migrations
|
||
```
|
||
|
||
### Откатить миграции к конкретной ревизии
|
||
|
||
```bash
|
||
REVISION="revision id" make revert-migrations
|
||
```
|
||
|
||
### Откатить последнюю миграцию
|
||
|
||
```bash
|
||
make revert-last-migration
|
||
```
|