Skip to content
AssRepDevelopmentPublic

About

core project backend

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Сборка и запуск проекта

Требования

  • Python 3.12
  • Docker и Docker Compose
  • Poetry 1.8.x

Быстрый старт в Docker

  1. Скопируйте значения окружения: cp .env.local.example .env.local и при необходимости замените пароли/порты.
  2. Запустите сервисы: docker compose up --build.
  3. API будет доступно на http://localhost:8000/api/health.
  4. Админ-панель будет доступна на http://localhost:8001.

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

  1. Установите зависимости: poetry install.
  2. Примените переменные окружения (можно взять из .env.local.example):
    • Убедитесь, что DATABASE_URL указывает на вашу базу (например, локальный Postgres или контейнер db из compose).
  3. Запустите сервер: uvicorn app.api.main:app --reload.
  4. Для админ-панели используйте: uvicorn app.admin.main:app --reload --port 8001.

Переменные окружения

  • APP_PORT — порт публикации FastAPI (по умолчанию 8000).
  • ADMIN_PORT — порт публикации админ-панели (по умолчанию 8001).
  • DEBUG — режим подробных логов SQLAlchemy.
  • POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB — учётные данные БД.
  • DATABASE_URL — строка подключения SQLAlchemy (async); в compose используется хост db.
  • S3_ENDPOINT_URL — внутренний endpoint S3 для backend-контейнера (локально обычно http://localstack:4566).
  • S3_PRESIGN_PUBLIC_ENDPOINT — endpoint, который будет попадать в presigned upload_url/url для клиентов.

Для локальной мобильной разработки обычно:

  • iOS simulator / web / curl с хоста: S3_PRESIGN_PUBLIC_ENDPOINT=http://localhost:4566
  • Android emulator: S3_PRESIGN_PUBLIC_ENDPOINT=http://10.0.2.2:4566

.env.local предназначен для локальной разработки и игнорируется Git. .env.lock хранит дефолтные значения для справки и тестов. Для стейджа/прода переменные задаются через GitHub Actions secrets при деплое.

Миграции и схема

  • Для dev-режима таблицы создаются автоматически при старте приложения.
  • Для продакшн-потока подключим Alembic и будем генерировать миграции вместо create_all.

Наполнение услуг

  • Файл каталога услуг: data/services.json.
  • Скрипт заполнения (идемпотентный): python scripts/seed_services.py.
  • Можно запускать повторно — данные будут обновляться по имени и родителю.

Alembic

  • Конфигурация: alembic.ini, скрипты в alembic/. URL берётся из DATABASE_URL (учитывает ENVIRONMENT).
  • Создать новую ревизию (автогенерация от моделей): alembic revision -m "name" --autogenerate.
  • Применить миграции: alembic upgrade head. Откат: alembic downgrade -1.
  • Initial ревизия: 0001_initial (создаёт все текущие таблицы).

Админ-панель

  • Основана на sqladmin, использует общие модели проекта.
  • Запуск в docker: сервис admin в docker-compose.yml (сборка через admin.Dockerfile).
  • Локальный запуск: uvicorn app.admin.main:app --reload --port 8001.

Линтеры/форматирование

  • Установка дев-зависимостей уже прописана в Poetry (black, isort).
  • Быстрый формат кода: make pretty (isort + black).
  • Проверка без изменений: make validate (isort/black в check-режиме).

About

core project backend

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages