Skip to content

README.md

Latest commit

 

History

History
82 lines (62 loc) · 3.23 KB

README.md

File metadata and controls

82 lines (62 loc) · 3.23 KB

Backlog

Backlog — сервис «списка хотелок» (backlog) для фильмов и сериалов. Позволяет сохранять фильмы и сериалы, добавлять ссылку на источник просмотра и быстро выбирать, что смотреть прямо сейчас.

Заметка от автора

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

Будущие фичи

  • Интеграция рейтинга IMDB, Кинопоиск
  • Автоматическое заполнение описания фильма, полученное от IMDB
  • Автоматический выбор фильма на просмотр из списка непросмотренных.
  • Возможность присоединяться к просмотру фильма, который был добавлен в общий список
  • Статистика пользователя

Технологии

codecov

Backend

  • Python 3.13+
  • FastAPI
  • SQLAlchemy
  • Alembic (миграции)
  • PostgreSQL
  • taskiq (фоновые задачи)
  • RabbitMQ
  • Jinja2

Frontend

  • Vite + Vue
  • NPM

Контейнеризация: Docker (+ docker-compose)

API (общая информация)

  • Базовый путь: /
  • Документация OpenAPI:
    • Swagger UI: /docs
    • ReDoc: /redoc

Примеры endpoint-ов:

  • GET /api/movies — получить список фильмов
  • POST /api/movies — добавить фильм
  • GET /api/movies/{id} — получить фильм по id
  • PUT /api/movies/{id} — обновить фильм
  • DELETE /api/movies/{id} — удалить фильм

Пример создания фильма (curl):

curl -X POST "http://localhost:8000/api/movies" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "title": "Inception",
    "rating": 8.7,
    "imdb_id": 1375666
  }'

Авторизация

Защищённые эндпоинты требуют заголовок:

Authorization: Bearer <access_token>

Вклад

  • Форкни репозиторий
  • Создай ветку: feature/my-feature
  • Сделай изменения и добавь тесты
  • Открой Pull Request: опиши цель изменений и план тестирования

Локальная разработка

Подробные инструкции по локальной установке, Docker и тестированию см. в DEVELOPMENT.md