[TC-642] modify template (#3)
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>
This commit is contained in:
committed by
Nadezhda Lavrentieva
parent
a4b2c99c25
commit
ac441a108b
50
README.md
50
README.md
@@ -12,26 +12,62 @@
|
||||
|
||||
# HOW TO
|
||||
|
||||
|
||||
## Настроить pre-commit и запустить проект
|
||||
### !!! (поменяйте креды в local.env на свои личные)
|
||||
|
||||
```bash
|
||||
make setup
|
||||
make setup-pre-commit
|
||||
make start
|
||||
|
||||
$ make setup
|
||||
$ make setup-pre-commit
|
||||
$ make start
|
||||
```
|
||||
|
||||
## Запустить тесты:
|
||||
|
||||
Note: тесты запускаются в локальной БД на локальной машине!
|
||||
Перед запуском проверьте, что у вас есть указанный в `tests.conftest` юзер с нужным паролем (можно указать свой) и
|
||||
Перед запуском проверьте, что у вас есть указанный в `tests.fixtures.db` юзер с нужным паролем (можно указать свой) и
|
||||
правами!
|
||||
|
||||
(И что в схеме public нет ничего нужного, потому что она дропается!)
|
||||
|
||||
```bash
|
||||
make test
|
||||
$ make test
|
||||
```
|
||||
|
||||
При локальном разворачивании документация доступна по адресу: http://0.0.0.0:8000/docs
|
||||
При локальном разворачивании документация доступна по адресу: 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user