template-backend-service

Базовый шаблон для микросервисов в Avroid

TODO:

• логирование
• докеризация
• кафка
• sentry
• миграции

HOW TO

Настроить pre-commit и запустить проект

!!! (поменяйте креды в local.env на свои личные)

$ make setup
$ make setup-pre-commit
$ make start

Запустить тесты:

Note: тесты запускаются в локальной БД на локальной машине! Перед запуском проверьте, что у вас есть указанный в tests.fixtures.db юзер с нужным паролем (можно указать свой) и правами!

(И что в схеме public нет ничего нужного, потому что она дропается!)

$ make test

При локальном разворачивании документация доступна по адресу: http://localhost:8000/docs

Проверить работоспособность сервиса

Простая healthcheck-проверка:

$ curl -s -o /dev/null -w "%{http_code}" http://localhost:8000/api/_/healthcheck

Ожидаем увидеть код ответа: 200.

Работа с миграциями

Создать/сгенерировать миграции

COMMENT="short human readable comment" make create-migrations

Применить миграции

make apply-migrations

Откатить миграции к конкретной ревизии

REVISION="revision id" make revert-migrations

Откатить последнюю миграцию

make revert-last-migration