simatheone / yamdb-api-docker

API Yamdb with docker

Проект API YamDB с использованием Docker 🚢

• Технологии
• Описание проекта
• Алгоритм регистрации пользователей
• Пользовательские роли
• Заполнение .env файла
• Запуск проекта

Используемые технологии

Python 3.7 🐍, Django 2.2.19 🖥️, Django Rest Framework 3.12.4 🔄, Docker 3.8 🚢, Nginx 🖌️, Postgres 📚

---

Проект YaMDb собирает отзывы пользователей на различные произведения

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Titles). Произведения делятся на категории:

• Книги
• Фильмы
• Музыка
• Искусство и многое другое

Список категорий (Category) может быть расширен администратором. Например, можно добавить категорию «Изобразительное искусство» или «Ювелирка».

Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку.

В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха.

Произведению может быть присвоен жанр (Genre) из списка предустановленных, например, «Сказка», «Рок» или «Артхаус». Новые жанры может создавать только администратор.

Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы (Review) и ставят произведению оценку в диапазоне от одного до десяти. Из пользовательских оценок формируется усреднённая оценка произведения — рейтинг. На одно произведение пользователь может оставить только один отзыв.

---

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

Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email и username на эндпоинт /api/v1/auth/signup/.

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

---

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

Аноним — может просматривать описания произведений, читать отзывы и комментарии.

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

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

Администратор (admin) — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.

Суперюзер Django — обладет правами администратора (admin).

---

Заполнение .env файла

В директории infra_sp2/infra/ создайте .env файл и укажите значения для переменных окружения:

• SECRET_KEY
• SERVERNAMES
• DB_ENGINE
• DB_NAME
• POSTGRES_USER
• POSTGRES_PASSWORD
• DB_HOST
• DB_PORT

---

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

Необходимо установить Docker на свою рабочую машину. Инструкцию можно найти на оффициальном сайте по Docker.

После установки Docker необходимо:

1. Клонировать репозиторий:

git clone https://github.com/Simatheone/api_yamdb.git

2. Перейти в директорию infra_sp2/infra:

cd infra_sp2/infra

3. В терминали запустить docker-compose

docker-compose up -d --build

По ссылке http://localhost/redoc будет доступна документаци к API.