Проект Foodgram

Описание

Проект — сайт Foodgram, «Продуктовый помощник». Это онлайн-сервис и API для него. На этом сервисе пользователи смогут публиковать рецепты, подписываться на публикации других пользователей, добавлять понравившиеся рецепты в список «Избранное», а перед походом в магазин скачивать сводный список продуктов, необходимых для приготовления одного или нескольких выбранных блюд.

Технологии

Django 3.2.6

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/foodgram-project-react.git

Для работы с удаленным сервером (на 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
sudo chmod +x /usr/local/bin/docker-compose

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

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>
  

• На сервере соберите 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
  

  • Загрузите ингридиенты в базу данных (необязательно):
    Если файл не указывать, по умолчанию выберется ingredients.json

  sudo docker-compose exec backend python manage.py load_ingredients <Название файла из директории data>
  

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

  sudo docker-compose exec backend python manage.py createsuperuser
  

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

Github Actions:

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

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

• Для работы с 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=<токен вашего бота>
  

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

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

Автор

Исхаков Тимур