todo-api

Веб сервис для работы со списком задач на день.

Быстрая установка и запуск

Для разворачивания сервиса в продакшн среде используется образ docker контейнера.

Для запуска можно:

• Воспользоваться готовым образом из хранилища образов GitHub.
• Самостоятельно собрать образ из исходных кодов.

Запуск релизной версии

Данный метод предпочтителен для развертывания в продакшн среде

Данный метод предпочтителен для целей регрессионного тестирования

Для запуска сервиса из готового образа необходимо выполнить комманду:

$ docker run --publish 8000:8000 ghcr.io/vpo-tusur/todo-api:latest

Запуск альфа-версии из готового образа

Данный метод предпочтителен для целей фиче-тестирования

Для запуска сервиса из готового образа необходимо выполнить комманду:

$ docker run --publish 8000:8000 ghcr.io/vpo-tusur/todo-api:alpha

Самостоятельная сборка и запуск образа

1. Перейти в корень репозитория.
2. Запустить сборку docker-образа:

# Сборка и запуск сервиса средствами docker
$ docker build -t todo-api . --file Dockerfile
$ docker run --publish 8000:8000 todo-api

# Сборка и запуск средствами docker compose
$ docker compose up --build

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

Запущенный сервис готов отображать страницу документации API - swagger, redoc:

localhost:8000/docs
localhost:8000/redoc

И готов исполнять имеющиеся эндпоинты.

Как внести свой вклад в проект

• Первые шаги и инструкции по установке.
• Описание архитектуры и справка по работе с инструментами.

Лицензия

© Apache 2.0 License.