lashkinse / foodgram-project-react

«Продуктовый помощник», онлайн-сервис и API для него

Проект Foodgram (foodgram-project-react)

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

Стек технологий

• Python 3.9
• Django 3.2
• Django REST framework
• Djoser
• Postgres

Документация

Описание функционала

Главная страница

Содержимое главной страницы — список первых шести рецептов, отсортированных по дате публикации (от новых к старым). Остальные рецепты доступны на следующих страницах: внизу страницы есть пагинация.

Страница рецепта

На странице — полное описание рецепта. Для авторизованных пользователей — возможность добавить рецепт в избранное и в список покупок, возможность подписаться на автора рецепта.

Страница пользователя

На странице — имя пользователя, все рецепты, опубликованные пользователем и возможность подписаться на пользователя.

Подписка на авторов

Подписка на публикации доступна только авторизованному пользователю. Страница подписок доступна только владельцу.

Сценарий поведения пользователя:

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

Список избранного

Работа со списком избранного доступна только авторизованному пользователю. Список избранного может просматривать только его владелец.

Сценарий поведения пользователя:

• Пользователь отмечает один или несколько рецептов кликом по кнопке «Добавить в избранное».
• Пользователь переходит на страницу «Список избранного» и просматривает персональный список избранных рецептов.
• При необходимости пользователь может удалить рецепт из избранного.

Список покупок

Работа со списком покупок доступна авторизованным пользователям. Список покупок может просматривать только его владелец.

Сценарий поведения пользователя:

• Пользователь отмечает один или несколько рецептов кликом по кнопке «Добавить в покупки».
• Пользователь переходит на страницу Список покупок, там доступны все добавленные в список рецепты. Пользователь нажимает кнопку Скачать список и получает файл с суммированным перечнем и количеством необходимых ингредиентов для всех рецептов, сохранённых в «Списке покупок».
• При необходимости пользователь может удалить рецепт из списка покупок.

Список покупок скачивается в формате .txt.

При скачивании списка покупок ингредиенты в результирующем списке не должны дублироваться; если в двух рецептах есть сахар (в одном рецепте 5 г, в другом — 10 г), то в списке должен быть один пункт: Сахар — 15 г.

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

• Фарш (баранина и говядина) (г) — 600
• Сыр плавленый (г) — 200
• Лук репчатый (г) — 50
• Картофель (г) — 1000
• Молоко (мл) — 250
• Яйцо куриное (шт) — 5
• Соевый соус (ст. л.) — 8
• Сахар (г) — 230
• Растительное масло рафинированное (ст. л.) — 2
• Соль (по вкусу) — 4
• Перец черный (щепотка) — 3

Фильтрация по тегам

При нажатии на название тега выводится список рецептов, отмеченных этим тегом. Фильтрация может проводится по нескольким тегам в комбинации «или»: если выбраны несколько тегов — в результате должны быть показаны рецепты, которые отмечены хотя бы одним из этих тегов.

При фильтрации на странице пользователя должны фильтроваться только рецепты выбранного пользователя. Такой же принцип должен соблюдаться при фильтрации списка избранного.

Регистрация и авторизация

В проекте доступна система регистрации и авторизации пользователей.

Обязательные поля для пользователя:

• Логин
• Пароль
• Email
• Имя
• Фамилия

Уровни доступа пользователей:

• Гость (неавторизованный пользователь)
• Авторизованный пользователь
• Администратор

Что могут делать неавторизованные пользователи:

• Создать аккаунт.
• Просматривать рецепты на главной.
• Просматривать отдельные страницы рецептов.
• Просматривать страницы пользователей.
• Фильтровать рецепты по тегам.

Что могут делать авторизованные пользователи:

• Входить в систему под своим логином и паролем.
• Выходить из системы (разлогиниваться).
• Менять свой пароль.
• Создавать/редактировать/удалять собственные рецепты
• Просматривать рецепты на главной.
• Просматривать страницы пользователей.
• Просматривать отдельные страницы рецептов.
• Фильтровать рецепты по тегам.
• Работать с персональным списком избранного: добавлять в него рецепты или удалять их, просматривать свою страницу избранных рецептов.
• Работать с персональным списком покупок: добавлять/удалять любые рецепты, выгружать файл с количеством необходимых ингредиентов для рецептов из списка покупок.
• Подписываться на публикации авторов рецептов и отменять подписку, просматривать свою страницу подписок.

Что может делать администратор:

Администратор обладает всеми правами авторизованного пользователя.

Плюс к этому он может:

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

Как запустить проект

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

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

https://github.com/lashkinse/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

• Скопировать на сервер папку infra (команды выполнять находясь в папке infra):

scp -r infra username@IP:infra   # 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

• После успешной сборки выполнить миграции из папки infra, при этом наполнится база данных содержимым из файла ingredients.csv:

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

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

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

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

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

Документация API

Полный список запросов и эндпоинтов описан в документации ReDoc, доступна после запуска проекта по адресу:

http://<server_ip_address>/api/docs/
http://<server_ip_address>/api/docs/swagger.html