Проект YaMDb (Docker)

Описание

Проект создан в рамках учебного курса Яндекс.Практикум.

Версия проекта без Docker контейнера: https://github.com/3gr1v750v/api_yamdb
Версия проекта, с Docker-compose и настройкой Github Actions Workflow с установкой не сервере Ubuntu : https://github.com/3gr1v750v/api_yamdb_CI

Проект YaMDb собирает отзывы пользователей на произведения. Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. Произведения делятся на категории, такие как «Книги», «Фильмы», «Музыка». Произведению может быть присвоен жанр из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Список категорий и жанров может быть расширен администратором.

Аутентифицированные пользователи могут оставлять к произведениям текстовые отзывы и выставлять произведениям оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Аутентифицированные пользователи также могут оставлять комментарии к отзывам.

Технологии

Python 3.7
Django 3.2
Django Rest Framework 3.12.4
Simple JWT 4.8
SQLite3
Docker-compose 3.8
PostgreSQL 13.0-alpine
Nginx 1.21.3-alpine
Gunicorn 20.0.4

Управление пользователями через API

Регистрация пользователя администратором проекта;
Самостоятельная регистрация пользователей;
Передача подтверждающего кода пользователю по электронной почте;
Присваивание JWT токена пользователю для аутентификации;
Изменение информации о пользователе;
Назначение ролей пользователей для управления ресурсами проекта;

Ресурсы проекта

Ресурс auth: аутентификация.
Ресурс users: пользователи.
Ресурс titles: произведения, к которым пишут отзывы (определённый фильм, книга или песенка).
Ресурс categories: категории (типы) произведений («Фильмы», «Книги», «Музыка»). Одно произведение может быть привязано только к одной категории.
Ресурс genres: жанры произведений. Одно произведение может быть привязано к нескольким жанрам.
Ресурс reviews: отзывы на произведения. Отзыв привязан к определённому произведению.
Ресурс comments: комментарии к отзывам. Комментарий привязан к определённому отзыву.

Документация

Подробное описание ресурсов доступно в документации после запуска проекта по адресу http://127.0.0.1:8000/redoc/.

В документации указаны эндпоинты (адреса, по которым можно сделать запрос), разрешённые типы запросов, права доступа и дополнительные параметры (паджинация, поиск, фильтрация итд.), когда это необходимо.

Примеры запросов

Регистрация пользователя:

POST /api/v1/auth/signup/

Получение данных своей учетной записи:

GET /api/v1/users/me/

Добавление новой категории:

POST /api/v1/categories/

Удаление жанра:

DELETE /api/v1/genres/{slug}

Частичное обновление информации о произведении:

PATCH /api/v1/titles/{titles_id}

Получение списка всех отзывов:

GET /api/v1/titles/{title_id}/reviews/

Добавление комментария к отзыву:

POST /api/v1/titles/{title_id}/reviews/{review_id}/comments/

Как запустить проект:

Запуск проекта:

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

git clone git@github.com:3gr1v750v/api_yamdb_docker.git

В директории infra создайте файл .env, откройте его и настройте параметры переменных окружения по заданному шаблону:

cp .env.example .env

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

docker-compose up -d

Для пересборки команда up выполняется с параметром --build

docker-compose up -d --build

Теперь в контейнере web нужно выполнить миграции:

docker-compose exec web python manage.py migrate

Создать суперпользователя:

docker-compose exec web python manage.py createsuperuser

Собрать статику:

docker-compose exec web python manage.py collectstatic --no-input

Проект готов к работе и доступен по адресу:

Раздел администрирования http://localhost/admin/

Адрес доступа API проекта http://localhost/api/v1/

Бекап и миграция базы данных

Вы также можете создать дамп (резервную копию) базы:

docker-compose exec web python manage.py dumpdata > fixtures.json

Чтобы скопировать файл базы данных в контейнер выполните команду из директории папки infra/:

docker cp fixtures.json <id>:app/

Выполните миграцию базы данных из директории папки infra/:

docker-compose exec web python manage.py loaddata fixtures.json

Авторы

Гривцов Евгений - https://github.com/EugeniGrivtsov

Задачи проекта: Система регистрации и аутентификации; права доступа; работа с токеном; система подтверждения через e-mail.

Пак Владислав - https://github.com/PakVla

Задачи проекта: Модели, view и эндпойнты для произведений, категорий и жанров. Реализация импорта данных из csv файлов.

Харитонов Тихон - https://github.com/TiEnddd

Задачи проекта: Модели, view и эндпойнты для отзывов, комментариев. Получение рейтинга произведений.

3gr1v750v / api_yamdb_docker