kutaraev / foodgram-recipes-service

Foodgram project template

Foodgram recipes service

Онлайн-сервис для публикации рецептов.

Содержание

• Описание проекта
• Технологии
• Установка
• Создание суперпользователя
• API
• Элементы интерфейса
• Планы по развитию проекта
• Контакты

Описание

Минималистичный, но функциональный веб-сервис для публикации кулинарных рецептов. Пользователи могут регистрироваться и создавать рецепты. Так же они могут подписываться на других авторов, добавлять рецепты в избранное и в список покупок (с возможностью выгрузки списка в pdf-файл). Бекенд взаимодействует с фронтендом, написанном на React'e, при помощи API. Проект является масштабируемым и легко может быть дополнен необходимыми функциями.

Технологии

• Python 3
• Django
• Django REST framework
• PostgreSQL
• Docker
• NGINX
• Gunicorn
• Git
• Visual Studio Code

Установка

• Установите 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

• Скопируйте на сервер файлы Docker-compose.yml и nginx.conf из папки infra-deploy/.

• Запустите контейнеры с помощью команды:

 docker-compose up

• Собрать статические файлы:

  docker-compose exec backend python3 manage.py collectstatic --noinput

• Произвести миграции:

 docker-compose exec backend python manage.py makemigrations
 docker-compose exec backend python manage.py migrate --noinput

• Загружаем ингредиенты в базу данных:

 docker-compose exec backend python manage.py loaddata dump.json

• Запуск контейнеров выполняется командой:

 docker-compose up

Создание суперпользователя

Для создания суперпользователя нужно ввести в терминале команду

docker-compose exec backend python manage.py createsuperuser

и ввести следующие данные:

• адрес электонной почты
• юзернейм
• имя
• фамилию
• пароль

Теперь можно запустить docker-compose, зайти на адрес http://127.0.0.1/admin/, залогиниться и работать с админкой Django.

API

Перечень эндпоинтов, а также формат и вид данных находятся по адресу http://127.0.0.1/api/docs/

Элементы интерфейса

В данном разделе показаны базовые элементы интерфейса сервиса "Продуктовый помощник"

Окно входа на сайт

Форма регистрации нового пользователя

Главная страница с рецептами

Окно создания рецепта

Страница подписок

Пример выгруженного списка покупок

Планы по развитию проекта

1. Создание системы рейтингов для рецептов.
2. Возможность оставлять комментарии под рецептами.
3. Возможность разбивать рецепты по тематическим группам.
4. Добавление фильтрации по времени приготовления.
5. Создание системы поиска рецептов.

Контакты

Артем Кутараев – @artem_kutaraev – [email protected]
Ссылка на проект – https://github.com/Kutaraev/FOODGRAM-recipes-service.git