README.md

Reviews_api

Проект Reviews_api собирает отзывы (Review) пользователей на произведения (Titles). Произведения делятся на категории: «Книги», «Фильмы», «Музыка». Список категорий (Category) может быть расширен администратором (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»). Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха. Произведению может быть присвоен жанр (Genre) из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Новые жанры может создавать только администратор. Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы (Review) и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Автор

• ✅ Imwisagist

Подготовка и запуск проекта

Склонировать репозиторий на локальную машину:

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

Для работы с удаленным сервером (на ubuntu):

• Выполните вход на свой удаленный сервер

• Установите docker на сервер:

sudo apt install docker.io 

• Установите docker-compose на сервер:

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

• Локально отредактируйте файл nginx.conf и в строке server_name впишите свой IP
• Скопируйте файлы docker-compose.yml и nginx.conf из репозитория на сервер:

scp docker-compose.yml <username>@<host>:/home/<username>/docker-compose.yml
scp nginx.conf <username>@<host>:/home/<username>/nginx.conf

• Cоздайте .env файл и впишите:

  DB_ENGINE=<django.db.backends.postgresql>
  DB_NAME=<имя базы данных postgres>
  DB_USER=<пользователь бд>
  DB_PASSWORD=<пароль>
  DB_HOST=<db>
  DB_PORT=<5432>
  SECRET_KEY=<секретный ключ проекта django>
  

• Для работы с Workflow добавьте в Secrets GitHub переменные окружения для работы:

  DB_ENGINE=<django.db.backends.postgresql>
  DB_NAME=<имя базы данных postgres>
  DB_USER=<пользователь бд>
  DB_PASSWORD=<пароль>
  DB_HOST=<db>
  DB_PORT=<5432>
  
  DOCKER_PASSWORD=<пароль от DockerHub>
  DOCKER_USERNAME=<имя пользователя>
  
  SECRET_KEY=<секретный ключ проекта django>
  USER=<username для подключения к серверу>
  HOST=<IP сервера>
  PASSPHRASE=<пароль для сервера, если он установлен>
  SSH_KEY=<ваш SSH ключ (для получения команда: cat ~/.ssh/id_rsa)>
  TELEGRAM_TO=<ID чата, в который придет сообщение>
  TELEGRAM_TOKEN=<токен вашего бота>
  

  Workflow состоит из трёх шагов:

  • Проверка кода на соответствие PEP8
  • Сборка и публикация образа бекенда на DockerHub.
  • Автоматический деплой на удаленный сервер.
  • Отправка уведомления в телеграм-чат.

• На сервере соберите docker-compose:

sudo docker-compose up -d --build

• После успешной сборки на сервере выполните команды (только после первого деплоя):
  • Соберите статические файлы:

  sudo docker-compose exec backend python manage.py collectstatic --noinput
  

  • Примените миграции:

  sudo docker-compose exec backend python manage.py migrate --noinput
  

  • Команда для заполнения базы начальными данными (необязательно):

  docker-compose exec web python manage.py loaddata fixtures.json
  

  • Создать суперпользователя Django:

  sudo docker-compose exec backend python manage.py createsuperuser
  

  • Проект будет доступен по вашему IP

Проект в интернете

Проект запущен и доступен по адресу