Проект Foodgram

«Продуктовый помощник»: приложение, на котором пользователи публикуют рецепты, подписываться на публикации других авторов и добавлять рецепты в избранное. Сервис «Список покупок» позволит пользователю создавать список продуктов, которые нужно купить для приготовления выбранных блюд.

Проект доступен по адресу foodgram-project.ddns.net

Документация к API доступна здесь

Тестовая учётка Администратора email: [email protected] password: 11qqaazz

В документации описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа.

Технологии:

Python, Django, Django Rest Framework, Docker, Gunicorn, NGINX, PostgreSQL, Yandex Cloud, Continuous Integration, Continuous Deployment

Развернуть проект на удаленном сервере:

• Клонировать репозиторий:

[email protected]:krankir/foodgram-project-react.git

• Установить на сервере Docker, Docker Compose:

sudo apt install curl                                   # установка утилиты для скачивания файлов
curl -fsSL https://get.docker.com -o get-docker.sh      # скачать скрипт для установки
sh get-docker.sh                                        # запуск скрипта
sudo apt-get install docker-compose-plugin              # последняя версия docker compose

• Скопировать на сервер файлы docker-compose.yml, nginx.conf из папки infra (команды выполнять находясь в папке infra):

scp docker-compose.yml nginx.conf username@IP:/home/username/   # username - имя пользователя на сервере
                                                                # IP - публичный IP сервера

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

SECRET_KEY              # секретный ключ Django проекта
DOCKER_PASSWORD         # пароль от Docker Hub
DOCKER_USERNAME         # логин Docker Hub
HOST                    # публичный IP сервера
USER                    # имя пользователя на сервере
PASSPHRASE              # *если ssh-ключ защищен паролем
SSH_KEY                 # приватный ssh-ключ
TELEGRAM_TO             # ID телеграм-аккаунта для посылки сообщения
TELEGRAM_TOKEN          # токен бота, посылающего сообщение

DB_ENGINE               # django.db.backends.postgresql
DB_NAME                 # postgres
POSTGRES_USER           # postgres
POSTGRES_PASSWORD       # postgres
DB_HOST                 # db
DB_PORT                 # 5432 (порт по умолчанию)

• Создать и запустить контейнеры Docker, выполнить команду на сервере (версии команд "docker compose" или "docker-compose" отличаются в зависимости от установленной версии Docker Compose):

sudo docker compose up -d

• После успешной сборки выполнить миграции:

sudo docker compose exec backend python manage.py migrate

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

sudo docker compose exec backend python manage.py createsuperuser

• Собрать статику:

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

• Наполнить базу данных содержимым из файла ingredients.csv:

sudo docker compose exec backend python manage.py load_ingredients

• Для остановки контейнеров Docker:

sudo docker compose down -v      # с их удалением
sudo docker compose stop         # без удаления

После каждого обновления репозитория (push в ветку master) будет происходить:

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

Запуск проекта на локальной машине:

• Клонировать репозиторий:

[email protected]:krankir/foodgram-project-react.git

• В директории infra файл example.env переименовать в .env и заполнить своими данными:

DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DB_HOST=db
DB_PORT=5432
SECRET_KEY='секретный ключ Django'

• Создать и запустить контейнеры Docker, как указано выше.

• После запуска проект будут доступен по адресу: http://localhost/

• Документация будет доступна по адресу: http://localhost/api/docs/

Автор backend'а:

Редько Анатолий 2023 г.