api_yamdb

Проект "Yamdb"

1. Общее описание:

C помощью данного проекта пользователи могут могут находить и создавать отзывы на произведения, такие как книги, фильмы или музыка. В проекте также настроена система комментирования отзывов.
Цель проекта - получение информационных данных пользователями.

2. Установка и запуск:

Клонировать репозиторий и перейти в него в командной строке:

git clone https://github.com/geniy132/api-final-yatube.git 

cd api-final-yatube 

Cоздать и активировать виртуальное окружение (для Windows):

python -m venv env 

source venv/Scripts/activate 

Установить зависимости из файла requirements.txt:

pip install -r requirements.txt 

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

python manage.py migrate 

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

python manage.py import_csv_data 

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

python manage.py runserver 

3. Использование:

Функциональная составляющая проекта реализуется посредство отправки запросов на эндпоинты. Документация к проекту доступна после запуска по адресу http://127.0.0.1:8000/redoc/.

4. Структура проекта:

Проект построен из трех основных приложений: reviews (отвечает за основную логику работы проекта), api (отвечает за предоставление интерфейса для взаимодействия между различными программными компонентами) и users (отвечает за пользовательскую модель).

5. Технологии:

Проект построен, как REST API, для взаимодействия с приложениями посредством
HTTP-методов и предоставляет ответы в формате JSON. Для работы проекта используются сторонние библиотеки. Логика проекта реализована на Python v3.12.7 посредством использования библиотек веб-фреймворка Django. API реализован посредством библитеки
djangorestframework. Для системы аутенфикации и регистрации пользователей использована библиотека djangorestframework_simplejwt.

6. Лицензирование:

Данный проект лицензирован образовательной платформой Yandex Практикум в 2025 г. Реализацию проекта выполнили студенты вышеупомянутой платформы Надежда Малюхина и Евгений Агаджанов.