romalosev / yamdb_final Goto Github PK

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

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

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

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

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

1. Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email и username на эндпоинт /api/v1/auth/signup/.
2. YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email.
3. Пользователь отправляет POST-запрос с параметрами username и confirmation_code на эндпоинт /api/v1/auth/token/, в ответе на запрос ему приходит token (JWT-токен). В результате пользователь получает токен и может работать с API проекта, отправляя этот токен с каждым запросом.
4. Для повторного получения письма с кодом подтверждения пользователь отправляет POST-запрос с параметрами username и email на эндпоинт /api/v1/auth/remind/.
5. При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/ и заполняет поля в своём профайле.
6. Если пользователя создаёт администратор, например, через POST-запрос на эндпоинт api/v1/users/ — письмо с кодом также приходит к нему на почту.

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

• Ресурс auth: аутентификация.
• Ресурс users: поль### Пример зывы на произведения. Отзыв привязан к определённому произведению.
• Ресурс comments: комментарии к отзывам. Комментарий привязан к определённому отзыву.

Установить docker, docker-compose на боевом сервере

ssh <username>@<server_ip>
sudo apt install docker.io
https://docs.docker.com/compose/install/ # docker-compose

• Заполнить в настройках репозитория секреты согласно env_template.txt
• В docker-compose web:image установить свой контейнер

Скопировать на сервер настройки docker-compose и nginx/

scp docker-compose.yaml <username>@<server_ip>:/home/<username>/
scp -r nginx/ <username>@<server_ip>:/home/<username>/nginx/

Собрать контейнер:

• docker-compose up -d

Выполнить следующие команды:

docker-compose exec web python manage.py makemigrations
docker-compose exec web python manage.py migrate --noinput 
docker-compose exec web python manage.py createsuperuser
docker-compose exec web python manage.py collectstatic --no-input
docker-compose exec web python manage.py loaddata fixtures.json  # По желанию закгрузить данные

• Установить и активировать виртуальное окружение
• Установить зависимости из файла requirements.txt

python -m pip install --upgrade pip

pip install -r requirements.txt

• Выполнить миграции:

python manage.py migrate

• В папке с файлом manage.py выполнить команду:

python manage.py runserver

• Для загрузки тестовых данных из csv-файлов выполнить команду:

python manage.py load_data

http://127.0.0.1/redoc/