Cервис, где пользователи могут публиковать рецепты, подписываться на публикации других пользователей, добавлять понравившиеся рецепты в список «Избранное», а перед походом в магазин скачивать сводный список продуктов, необходимых для приготовления одного или нескольких выбранных блюд.
Пример развернутого проекта можно посмотреть здесь
Django==2.2
Django-rest-framework==3.12.4
Python==3.8.10
PostgreSQL
Docker
Проект запускается в четырёх контейнерах docker-compose
| IMAGES | NAMES | DESCRIPTIONS |
|---|---|---|
| nginx:1.19.3 | infra_nginx_1 | контейнер HTTP-сервера |
| postgres:12.4 | infra_db_1 | контейнер базы данных на PostgreSQL |
| foodgram_backend | infra_web_1 | контейнер backend-части Django приложения |
| foodgram_frontend | infra_frontend_1 | контейнер frontend-части проекта JS-React |
*Примечание: При выполнении команды docker-compose up сервис frontend подготовит файлы, необходимые для работы фронтенд-приложения, а затем прекратит свою работу и будет работать через nginx.
Чтобы развернуть проект, вам потребуется:
- Клонировать репозиторий GitHub (не забываем создать виртуальное окружение и установить зависимости):
git clone https://github.com/nonwander/foodgram-project-react- Создать файл
.envв папке проекта /infra/ и заполнить его всеми ключами:
DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=f00dgram
DB_HOST=db
DB_PORT=5432
DJANGO_SECRET_KEY=<ваш_django_секретный_ключ>
Вы можете сгенерировать DJANGO_SECRET_KEY следующим образом.
Из директории проекта /backend/ выполнить:
python manage.py shell
from django.core.management.utils import get_random_secret_key
get_random_secret_key()Полученный ключ скопировать в .env.
- Собрать контейнеры:
cd foodgram-project-react/infra
docker-compose up -d --buildПри успешном создании контейнеров в терминале должен быть статус:
Status: Downloaded newer image for nginx:1.19.3
Creating infra_db_1 ... done
Creating infra_web_1 ... done
Creating infra_nginx_1 ... done
- Сделать миграции, собрать статику и создать суперпользователя:
docker-compose exec -T web python manage.py makemigrations users --noinput
docker-compose exec -T web python manage.py makemigrations recipes --noinput
docker-compose exec -T web python manage.py migrate --noinput
docker-compose exec -T web python manage.py collectstatic --no-input
docker-compose exec web python manage.py createsuperuserЧтобы заполнить базу данных начальными данными списка ингридиетов выполните:
docker-compose exec -T web python manage.py loaddata data/ingredients_1.json Теперь можно зайти в админку http://<ваш хост>/admin/ под вашим логином администратора.
В сервисе предусмотрена система регистрации и авторизации пользователей. Обязательные поля для пользователя:
- создать аккаунт;
- просматривать рецепты на главной;
- просматривать отдельные страницы рецептов;
- фильтровать рецепты по тегам;
- входить в систему под своим логином и паролем;
- выходить из системы (разлогиниваться);
- менять свой пароль;
- создавать/редактировать/удалять собственные рецепты;
- просматривать рецепты на главной;
- просматривать страницы пользователей;
- просматривать отдельные страницы рецептов;
- фильтровать рецепты по тегам;
- работать с персональным списком избранного: добавлять в него рецепты или удалять их, просматривать свою страницу избранных рецептов;
- работать с персональным списком покупок: добавлять/удалять любые рецепты, выгружать файл со количеством необходимых ингридиентов для рецептов из списка покупок;
- подписываться на публикации авторов рецептов и отменять подписку, просматривать свою страницу подписок;
Администратор обладает всеми правами авторизованного пользователя.
Плюс к этому он может:
- изменять пароль любого пользователя;
- создавать/блокировать/удалять аккаунты пользователей;
- редактировать/удалять любые рецепты;
- добавлять/удалять/редактировать ингредиенты;
- добавлять/удалять/редактировать теги.
В интерфейс админ-зоны выведены следующие поля моделей и фильтры:
Доступны все модели с возможностью редактирования и удаления записей.
Фильтр по email и имени пользователя.
В списке рецептов доступны название и авторы рецептов.
Фильтры по автору, названию рецепта, тегам.
Выведена информация о популярности рецепта: общее число добавлений этого рецепта в избранное пользователей.
В списке ингредиентов доступны название ингредиента и единицы измерения.
Фильтр по названию.
Рецепт описывается полями:
Автор публикации (пользователь).
Название рецепта.
Картинка рецепта.
Текстовое описание.
Ингредиенты: продукты для приготовления блюда по рецепту с указанием количества и единиц измерения.
Тег.
Время приготовления в минутах.
Тег описывается полями:
Название.
Цветовой HEX-код.
Slug.
Ингредиент описывается полями:
Название.
Количество (только для рецепта).
Единицы измерения.
Список покупок скачивается в текстовом формате: shopping-list.txt.
При нажатии на название тега выводится список рецептов, отмеченных этим тегом. Фильтрация может проводится по нескольким тегам в комбинации «или»: если выбраны несколько тегов — в результате должны быть показаны рецепты, которые отмечены хотя бы одним из этих тегов. При фильтрации на странице пользователя фильтруются только рецепты выбранного пользователя. Такой же принцип соблюдается при фильтрации списка избранного.
Запросы к API начинаются с «/api/v1/»
- регистрация пользователя
POST-запрос: /api/users/
Request sample:
{
"email": "string",
"username": "string",
"first_name": "string",
"last_name": "string",
"password": "string"
}Response sample (201):
{
"email": "string",
"id": 0,
"username": "string",
"first_name": "string",
"last_name": "string"
}Response sample (400):
{
«field_name»: [
«Обязательное поле.»
]
}- Получение токена
POST-запрос: /api/auth/token/login/
Request sample:
{
«email»: «string»,
«password»: «string»
}Response sample (201):
{
«token»: «string»
}Response sample (400):
{
«field_name»: [
«string»
]
}Увидеть полную спецификацию API вы сможете развернув проект локально http://127.0.0.1/api/docs/ или на вашем хосте.
Немыкин Евгений
nonwander@gmail.com
Telegram: @nonwander