Описание проекта:
YaMDb - это API для сбора и хранения отзывов пользователей о произведениях искусства.
Цель проекта:
Создать API, позволяющий пользователям оставлять отзывы о книгах, фильмах, музыке и других произведениях, а также просматривать рейтинги и комментарии к ним.
Возможности API:
- Аутентификация и авторизация: API использует JWT-токены для аутентификации пользователей.
- Управление пользователями:
- Регистрация пользователей с подтверждением по email.
- Авторизация пользователей с помощью username и password.
- Изменение профиля пользователя.
- Работа с произведениями:
- Получение списка произведений по категориям.
- Поиск произведений по названию.
- Получение подробной информации о произведении.
- Добавление, редактирование и удаление произведений (только администраторы).
- Работа с категориями:
- Получение списка категорий.
- Добавление, редактирование и удаление категорий (только администраторы).
- Работа с жанрами:
- Получение списка жанров.
- Добавление, редактирование и удаление жанров (только администраторы).
- Работа с отзывами:
- Добавление, редактирование и удаление отзывов (только авторизованные пользователи).
- Поиск отзывов по произведению.
- Установка рейтинга произведения.
- Работа с комментариями:
- Добавление, редактирование и удаление комментариев (только авторизованные пользователи).
- Получение списка комментариев к отзыву.
Настройка и запуск:
-
Клонируйте репозиторий:
git clone https://github.com/Dmkdok/api_yamdb.git
-
Создайте и активируйте виртуальное окружение:
python -m venv venv source venv/bin/activate -
Установите зависимости:
pip install -r requirements.txt
-
Настройте базу данных:
Измените настройки базы данных в файле
settings.py. -
Запустите миграции:
python manage.py makemigrations python manage.py migrate
-
Запустите сервер разработки:
python manage.py runserver
Документация:
Полная документация по API YaMDb доступна по адресу: http://127.0.0.1:8000/redoc/.
Данные:
Данные для инициализации базы данных находятся в директории /api_yamdb/static/data.
Разработка:
- Разработчики: Чепрага Елена, Богданов Дмитрий
Лицензия:
- MIT