Burger API

Бекенд для веб-приложения Stellar Burgers - демо-приложение на котором я пробую и обкатываю технологии.

⚠️ Work In Progress

Кроме собственно кода проекта рекомендую заглянуть в доки - например, сюда. Там красивые графики и диаграммы с замерами производительности.

Разработка

Начало работы

Если вы используете NixOS (как и я btw), то для настройки окружения достаточно выполнить команду:

nix-shell

Если у вас не NixOS и ещё не установлен uv, установите 😼 Документация

После чего выполните команду

uv sync

Управление зависимостями в проекте ведётся через uv.

Локальный запуск

Перед первым запуском создайте .env файл с помощью команды:

./pleh.sh init-dotenv

Накатить миграции по инструкции ниже.

Затем, запустите приложение со всем окружением через docker compose

docker compose up --build -d

Приложение запустится в контейнере burger-api с примонтировнными директориями app и scripts и включенным hot-reload. После этого можно дёргать ручки по адресу http://localhost:8000 или через интерфейс swagger по адресу http://localhost:8000/docs.

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

docker container exec burger-api ./pleh.sh script scripts/load_default_ingredients.py

Альтернативный вариант

Если хочется запустить приложение на хосте, а не в контейнере (например, для удобства отладки), можно сделать так:

0. Подправить .env файл заменив в нём доменные имена rabbitmq и базы данных на localhost
1. Поднять окружение и приложение по предыдущей инструкции
2. Остановить контейнер burger-api docker container stop burger-api
3. Запустить приложение с помощью команды python main.py

Pleh.sh

В репозитории содержится bash скрипт со всякими полезностями.

Примеры использования:

# Документация по использованию скрипта
./pleh.sh

# Запуск скриптов из директории scripts
./pleh.sh script scripts/load_default_ingredients.py

# Запуск тестов
./pleh.sh test
# Можно добавить аргументов для pytest
./pleh.sh test -vv -k 'ingredient'

# Форматирование кода
./pleh.sh format

Миграции

Миграции базы данных применяются до запуска приложения. Чтобы накатить миграции нужно:

1. Поднять контейнер с базой данных, если ещё нет

docker compose up db -d

2. Прогнать миграции 2.1. Проверить url до базы данных в .env 2.2. Запустить скрипт миграции:

alembic upgrade head