Проект YaMDb

Описание проекта:

Проект представляет собой платформу для сбора отзывов пользователей на различные произведения, такие как фильмы, книги и музыка. В этом файле вы найдете основную информацию о проекте, его ресурсах, пользовательских ролях и доступе, а также инструкции по работе с Postman-коллекцией для тестирования API. Проект YaMDb позволяет пользователям оставлять отзывы и ставить оценки различным произведениям. Самыми важными аспектами проекта являются:

Жанры произведений: Произведению можно присвоить жанр из списка предустановленных, такие как "Сказка", "Рок" или "Артхаус".

Отзывы и оценки: Пользователи могут оставлять текстовые отзывы и ставить оценки произведениям в диапазоне от одного до десяти (целое число). Из пользовательских оценок формируется усреднённая оценка произведения - рейтинг.

Комментарии: Пользователи могут оставлять комментарии к отзывам других пользователей.

Аутентификация: Добавление отзывов, комментариев и оценок доступно только аутентифицированным пользователям.

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

git clone git@github.com:SerVik888/api_yamdb.git -> клонировать репозиторий

• Если у вас Linux/macOS
  python3 -m venv env -> создать виртуальное окружение
  source env/bin/activate -> активировать виртуальное окружение
  python3 -m pip install --upgrade pip -> обновить установщик
  pip install -r requirements.txt -> установить зависимости из файла requirements.txt
  cd api_yamdb -> перейти в папку
  python3 manage.py migrate -> выполнить миграции
  python3 manage.py createsuperuser -> создать суперпользователя
  python3 manage.py runserver -> запустить проект
  python3 manage.py import_csv -> загрузка данных из файлов csv
• Если у вас windows
  python -m venv venv -> создать виртуальное окружение
  source venv/Scripts/activate -> активировать виртуальное окружение
  python -m pip install --upgrade pip -> обновить установщик
  pip install -r requirements.txt -> установить зависимости из файла requirements.txt
  cd api_yamdb -> перейти в папку
  python manage.py migrate -> выполнить миграции
  python manage.py createsuperuser -> создать суперпользователя
  python manage.py runserver -> запустить проект
  python manage.py import_csv -> загрузка данных из файлов csv

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

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

• Выполнить команду pytest из корня проекта
• Коллекция запросов для Postman Для тестирования и отладки работы текущей версии API для проекта YaMDb, мы предоставляем коллекцию запросов для Postman. Вы можете импортировать эту коллекцию в Postman и выполнять запросы для проверки функциональности API.

Подробная инструкция по работе с коллекцией находится в файле /postman_collection/README.md.

Cписок используемых технологий:

• Django
• pytest
• djangorestframework
• djangorestframework-simplejwt

Авторы: Сафонов Сергей https://github.com/SerVik888 sergey_safonov86@inbox.ru
Чупахин Александр https://github.com/chew6aca
Королев Олег https://github.com/Helg93