Перейти к содержанию

Добро пожаловать в Gifty Engineering 🎁

Этот портал содержит всю техническую документацию по проекту Gifty — умной платформе для подбора подарков.

О проекте

Gifty помогает пользователям находить идеальные подарки, используя современные алгоритмы машинного обучения и векторного поиска. Мы агрегируем данные с популярных площадок, анализируем их с помощью ИИ и предоставляем удобный интерфейс для поиска.

Навигация по разделам

  • Архитектура: Как всё устроено внутри — от парсинга до рекомендаций.
  • API Reference: Автоматически сгенерированная документация к классам и функциям Python.
  • Гайды: Инструкции по настройке окружения, правилам разработки и деплою.

Быстрый старт для разработчиков

  1. Клонируйте репозиторий.
  2. Создайте виртуальное окружение: python -m venv .venv
  3. Установите зависимости: pip install -r requirements.txt
  4. Настройте .env файл (шаблон в .env.example).
  5. Запустите бэкенд: uvicorn app.main:app --reload

[!TIP] Final Pipeline Test: Verifying build check for docs/* branches while documentation is the primary branch.

[!NOTE] Если вы нашли ошибку в документации или хотите добавить новый раздел, не стесняйтесь создавать Pull Request!