Skip to content
@hell-kitchen

Hell Kitchen

Hell kitchen is helper to create and get recipes

hell-kitchen

Немного о проекте

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

Базовые модели проекта

Более подробно с базовыми моделями можно ознакомиться в спецификации API.

Рецепт

Рецепт должен описываться такими полями:

  • Автор публикации (пользователь).
  • Название.
  • Картинка.
  • Текстовое описание.
  • Ингредиенты: продукты для приготовления блюда по рецепту. Множественное поле, выбор из предустановленного списка, с указанием количества и единицы измерения.
  • Тег (можно установить несколько тегов на один рецепт, выбор из предустановленных).
  • Время приготовления в минутах.

Все поля обязательны для заполнения.

Тег

Тег должен описываться такими полями:

  • Название.
  • Цветовой HEX-код (например, #49B64E).
  • Slug.

Все поля обязательны для заполнения и уникальны.

Ингредиент

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

  • Название.
  • Количество.
  • Единицы измерения.

Все поля обязательны для заполнения.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

При необходимости пользователь может удалить рецепт из списка покупок. Список покупок скачивается в формате .txt (или, по желанию, можно сделать выгрузку PDF).

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

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

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

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

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

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

В проекте должна быть доступна система регистрации и авторизации пользователей. Чтобы собрать весь код для управления пользователями воедино — сервис users.

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

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

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

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

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

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

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

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

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

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

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

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

Технические требования и инфраструктура

Frontend:

  1. React + ts
  2. Работа с бэкендом по rest API

Backend:

  1. Система должна быть разработана в микросервисной архитектуре.
  2. Должна быть реализована асинхронная коммуникация сервисам по средствам брокера сообщений (kafka)

Popular repositories

  1. api-gateway api-gateway Public

    Go 1

  2. .github .github Public

  3. frontend frontend Public

    TypeScript

  4. tags tags Public

    Go

  5. pkg pkg Public

    Go

  6. telegram-bot telegram-bot Public

    Python

Repositories

Showing 9 of 9 repositories

Top languages

Loading…

Most used topics

Loading…