REST API для сервиса YaMDb — базы отзывов о фильмах, книгах и музыке.

Description

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Title). Произведения делятся на категории: «Книги», «Фильмы», «Музыка». Список категорий (Category) может быть расширен (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»). Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха. Произведению может быть присвоен жанр из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Новые жанры может создавать только администратор. Благодарные или возмущённые читатели оставляют к произведениям текстовые отзывы (Review) и выставляют произведению рейтинг (оценку в диапазоне от одного до десяти). Из множества оценок автоматически высчитывается средняя оценка произведения.

Пользовательские роли

• Аноним — может просматривать описания произведений, читать отзывы и комментарии.
• Аутентифицированный пользователь (user)— может читать всё, как и Аноним, дополнительно может публиковать отзывы и ставить рейтинг произведениям (фильмам/книгам/песенкам), может комментировать чужие отзывы и ставить им оценки; может редактировать и удалять свои отзывы и комментарии.
• Модератор (moderator) — те же права, что и у Аутентифицированного пользователя плюс право удалять и редактировать любые отзывы и комментарии.
• Администратор (admin) — полные права на управление проектом и всем его содержимым. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.
• Администратор Django — те же права, что и у роли Администратор.

Алгоритм регистрации пользователей

Пользователь отправляет POST-запрос с параметром email на /api/v1/auth/email/. YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email . Пользователь отправляет POST-запрос с параметрами email и confirmation_code на /api/v1/auth/token/, в ответе на запрос ему приходит token (JWT-токен).

Getting Started

Создайте .env с настройками для подключения к БД

- DB_ENGINE=django.db.backends.postgresql
- DB_NAME=Имя БД
- POSTGRES_USER=пользователь
- POSTGRES_PASSWORD=пароль
- DB_HOST=db
- DB_PORT=5432

Запуск проекта выполняется командой docker-compose up

Далее необходимо выполнить следующий шаги

• открываем терминал docker exec -it web bash
• создание миграций python manage.py makemigrations
• миграция python manage.py migrate
• создание администратора python manage.py createsuperuser

Built With

• DRF - Django Rest Framework
• PostgreSQL
• Nginx
• Docker
• Docker-compose

Versioning

На данный момент версия проекта v1. Чтобы узнать доступные версии смотрите теги в этом репозитории.

Authors

Balashov Konstantin

Acknowledgments

Спасибо, всем кто воспользовался данным сервисом, буду рад обратной связи.