Чтобы настроить окружение, необходимо набрать в терминале
virtualenv .venv venv
source activate .venv/bin/activate
make venv
Чтобы настроиться на локальную базу данных заменить переменную
DATABASE_URL=postgresql+psycopg2://realtime:realtime@localhost:5432/realtime_news
Чтобы настроиться на серверную базу данных заменить переменную
DATABASE_URL=postgresql+psycopg2://realtime:[email protected]:5432/realtime_news
Чтобы наполнить локальную базу тестовыми значениями:
- настройтесть на локальную базу
- выполните
make populate
Чтоб отформатировать код make pretty
Чтоб пройти линтеры в коде make lint
Чтоб прогнать тесты make test
Чтобы поднять локально сервис и подёргать ручки: make up
Сервис сделан на fastapi, а он поддерживает сваггер: то есть вы можете посмотреть, какие ручки есть. Чтобы воспользоваться этим, перейдите на эндпоинт /docs&
Пока работает только для веб-сервиса
Если есть проблемы с выполнением команд в терминале, откройте Makefile и выполните команды последовательно