oorzhakau/infra_sp2

infra_sp2

Cпринт 15

Развертывание проекта API YaMDb 🔍 через docker-compose

---

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

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

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

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

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

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

Техническое описание проекта

К проекту по адресу http://localhost/redoc/ подключена документация API YaMDb. В ней описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа: пользовательские роли, которым разрешён запрос.

Технологии:

• Python 3.7
• Django 2
• Docker
• Nginx

Установка:

1. Клонируйте репозиторий на локальную машину. git clone https://github.com/Oorzhakau/infra_sp2.git
2. Установите виртуальное окружение в папке проекта.

cd infra_sp2
python -m venv venv

3. Активируйте виртуальное окружение. source venv\Scripts\activate
4. Установите зависимости.

python -m pip install --upgrade pip
pip install -r api_yamdb\requirements.txt

Запуск проекта в контейнерах

1. Перейдите в директорию infra/, заполните файл .venv_example и после этого переименуйте его в .env
2. Выполните команду: docker-compose up -d --build
3. Для остановки контейнеров из директории infra/ выполните команду: docker-compose down -v
4. Загрузка данных для примера из папки infra/ docker-compose exec web python manage.py loaddata fixtures.json

Проверка работы приложения

Для проверки работы приложения, при запущенном виртуальном окружении, из корня директории выполните команду pytest

Автор:

Александр Ооржак