Проект YaMDb (API)

Разработчики API:

• Куллина Наталья
• Исхаков Тимур
• Сергеев Андрей

Описание:

Проект YaMDb собирает отзывы пользователей на произведения. Произведения делятся на категории. Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. В каждой категории есть произведения: книги, фильмы или музыка. Произведению может быть присвоен жанр из списка предустановленных. Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы и ставят произведению оценку в диапазоне от одного до десяти; из пользовательских оценок формируется усреднённая оценка произведения — рейтинг.

Реализовано:

• регистрация пользователя и выдача токенов;
• работа с категориями, жанрами, произведениями, отзывами и комментариями;
• возможность просматривать и изменять свою учетную запись.

Технологии:

Django 2.2.16

djangorestframework 3.12.4

PostgreSQL 13.0-alpine

Nginx 1.21.3-alpine

Gunicorn 20.0.4

Docker 20.10.17, build 100c701

Docker-compose 3.3

Установка локально:

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

git clone https://github.com/Timik2t/yamdb_final.git

В директории infra создайте файл .env с переменными окружения для работы с базой данных:

DJANGO_KEY='your Django secret key'
DB_ENGINE=django.db.backends.postgresql # указываем, что работаем с postgresql
DB_NAME=postgres # имя базы данных
POSTGRES_USER=postgres # логин для подключения к базе данных
POSTGRES_PASSWORD=postgres # пароль для подключения к БД (установите свой)
DB_HOST=db # название сервиса (контейнера)
DB_PORT=5432 # порт для подключения к БД

• Из папки infra/ разверните контейнеры в новой структуре:
• Для запуска необходимо выполнить из директории с проектом команду: sudo docker-compose up -d Для пересборки команда up выполняется с параметром --build sudo docker-compose up -d --build
• Теперь в контейнере web нужно выполнить миграции: sudo docker-compose exec web python manage.py migrate
• Создать суперпользователя: sudo docker-compose exec web python manage.py createsuperuser
• Собрать статику: sudo docker-compose exec web python manage.py collectstatic --no-input
• Вы также можете создать дамп (резервную копию) базы: sudo docker-compose exec web python manage.py dumpdata > fixtures.json
• или, разместив, например, файл fixtures.json в папке с Dockerfile, загрузить в базу данные из дампа: sudo docker-compose exec web python manage.py loaddata fixtures.json

Установка на удаленный сервер

Для запуска проекта на удаленном сервере необходимо:

• скопировать на сервер файлы docker-compose.yaml, .env и папку nginx командами:

scp docker-compose.yaml  <user>@<server-ip>:
scp .env <user>@<server-ip>:
scp -r nginx/ <user>@<server-ip>:

• создать переменные окружения в разделе secrets настроек текущего репозитория:

DOCKER_PASSWORD # Пароль от Docker Hub
DOCKER_USERNAME # Логин от Docker Hub
HOST # Публичный ip адрес сервера
USER # Пользователь зарегистрированный на сервере
PASSPHRASE # Если ssh-ключ защищен фразой-паролем
SSH_KEY # Приватный ssh-ключ машины с доступом на удаленный сервер
TELEGRAM_TO # ID телеграм-аккаунта
TELEGRAM_TOKEN # Токен бота

Github Actions:

После обновления репозитория автоматически будут выполнены действия:

1. Проверка кода на соответствие стандарту PEP8 (с помощью пакета flake8) и запуск pytest из репозитория yamdb_final
2. Сборка и доставка докер-образов на Docker Hub.
3. Автоматический деплой.
4. Отправка уведомления в Telegram.

---

Полная документация работы с api:

• документация
• локальный сервер

Работающий сервер (IP изменить на свой)

• сервер
• админ панель
• документация