Skip to content

Nishela/YP_Async_API_service

Repository files navigation

Проектная работа 4-5 спринтов

Основные сервисы

  • api_service для Fast api + тесты для сервиса
  • etl_service для запуска ETL pipeline
  • nginx для проксирования запросов

Доп сервисы

  • база Postgres
  • база Elasticsearch
  • база Redis

Инструкция по использованию


Запуск и тестирование

Запуск:

  1. Создаем файл .env на примере .env.example
  2. Выполняем сборку и запуск проекта:
$ make run

Запускаются:

  • база Postgres
  • база Elasticsearch
  • база Redis
  • ETL сервис
  • Fast API service
  • сервер nginx

Для тестирования сервиса и просмотра документации в swagger, перейдите по ссылке: http://0.0.0.0/api_service/openapi#

Тестирование :

  • сборка контейнера и запуск тестов c последующим удалением всех контейнеров, в сборку входят: сами тесты, ES, REDIS (полезно для одноразовой проверки):
make tests_run
  • сборка/пересборка контейнера с тестами и запуск тестов без удаления сборки (полезно после рефакторинга кода, если не хочется удалять контейнеры с ES, Redis):
make tests_up
  • удаление всей сборки
make tests_down

Makefile функции:

  • сборка проекта:
make build
  • сброс сохраненного состояния(для загрузки всей базы заново):
make drop-state
  • запуск проекта:
make up
  • запуск контейнера с тестами:
make tests_run
  • удаление контейнера с тестами проекта:
make tests_down
  • остановить и удалить контейнеры и другие ресурсы, созданные командой docker-compose up
 make down
  • собрать и сразу запустить проект
make run
  • остановить контейнеры проекта, но не удалять их
make stop
  • запуск остановленных контейнеровп проекта
make start
  • просмотр логов
make logs

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published