Проект Foodgram
Foodgram - продуктовый помощник с базой кулинарных рецептов. Позволяет публиковать рецепты, сохранять избранные, а также формировать список покупок для выбранных рецептов. Можно подписываться на любимых авторов.
Проект доступен по адресу
Документация к API доступна здесь
В документации описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа.
Технологии:
Python, Django, Django Rest Framework, Docker, Gunicorn, NGINX, PostgreSQL, Yandex Cloud, Continuous Integration, Continuous Deployment
Развернуть проект на удаленном сервере:
- Клонировать репозиторий:
https://github.com/mikhailsoldatkin/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.json:
sudo docker compose exec backend python manage.py loaddata ingredients.json
- Для остановки контейнеров Docker:
sudo docker compose down -v # с их удалением
sudo docker compose stop # без удаления
После каждого обновления репозитория (push в ветку master) будет происходить:
- Проверка кода на соответствие стандарту PEP8 (с помощью пакета flake8)
- Сборка и доставка докер-образов frontend и backend на Docker Hub
- Разворачивание проекта на удаленном сервере
- Отправка сообщения в Telegram в случае успеха
Запуск проекта на локальной машине:
- Клонировать репозиторий:
https://github.com/mikhailsoldatkin/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'а:
Михаил Солдаткин (c) 2022
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent