Chack Check Users Service

Сервис, управляющий пользователями и аутентификацией

• https://stage.chack-check.ru/api/v1/users - стейдж окружение, там же есть документация GraphiQL

Предустановка

Надо поставить docker compose, ну и make, для удобства

Запуск проекта

Перед запуском проекта нужно создать docker network, чтобы сервисы могли общаться между собой:

$ docker network create chack-check-network

Network нужно создавать только один раз

Для дев окружения .env файлик лежит в репе, не игнорится. Поэтому пока не буду описывать env vars

Непосредственно запуск:

make

$ make dev

docker compose plugin

$ docker compose -f docker-compose.dev.yml up --build

После запуска

Юзается GraphQL, так что для тестирования запросов можно зайти на http://localhost:8000/api/v1/users/

Там появится интерфейс, в котором можно найти описание GraphQL types

Запуск линта локально

Чтобы запустить линтинг кода локально, нужно выполнить:

$ make lint

Запуск тестов локально

Чтобы запустить тесты локально, нужно выполнить:

$ make run_tests

Создание миграции

Чтобы создать миграцию после каких-либо изменений в модели, нужно выполнить:

$ make migrations name="Some migration name"

Some migration name - имя создаваемой миграции

Регенерация protobuf

В директории app запустить следующую команду:

$ python -m grpc_tools.protoc -I . --python_out=./protobuf --pyi_out=./protobuf --grpc_python_out=./protobuf users.proto