Ссылка на проект: TastyVerse
Looking for English version? Check here --> click or scroll down.
TastyVerse предоставляет следующие возможности:
-
Добавление и редактирование рецептов: Создайте красиво оформленные рецепты, добавляйте фотографии ваших блюд и расскажите другим, как приготовить их шаг за шагом.
-
Поиск рецептов: Ищите рецепты по тегам и авторам.
-
Сохранение в избранное: Добавляйте понравившиеся рецепты в свою коллекцию избранных, чтобы легко найти их в будущем.
-
Список покупок: Создавайте список покупок на основе ингредиентов, необходимых для приготовления выбранных блюд, и сохраняйте его. Позже вы сможете скачать этот список в формате PDF и распечатать, чтобы ничего не забыть при походе в магазин.
-
Подписка на авторов: Вы можете подписываться на авторов, чьи рецепты вас вдохновляют, чтобы всегда быть в курсе их новых кулинарных идей.
Репозиторий включает в себя два файла docker-compose.yml и docker-compose.production.yml, что позволяет развернуть проект на локальном или удалённом серверах.
Данная инструкция подразумевает, что на вашем локальном/удалённом сервере уже установлен Git, Python 3.10, пакетный менеджер pip, Docker, Docker Compose, утилита виртуального окружения python3-venv.
В проекте предусмотрена возможность запуска БД SQLite3 и PostgreSQL. Выбор БД осуществляется сменой значения DEBUG на True или False. True = SQLite3, False = PostgreSQL.
С подробными инструкциями запуска вы можете ознакомиться ниже.
Склонируйте проект из репозитория:
git clone https://github.com/PrimeStr/tasty-verse.gitПерейдите в директорию проекта:
cd tasty-verse/Перейдите в директорию infra и создайте файл .env:
cd infra/nano .envДобавьте строки, содержащиеся в файле .env.example и подставьте свои значения.
Пример из .env файла:
# БД выбирается автоматически на основе константы DEBUG. Если DEBUG = True , используется SQLite3.
# Если DEBUG = False , используется PostgreSQL.
POSTGRES_USER=django_user # Ваше имя пользователя для бд
POSTGRES_PASSWORD=django # Ваш пароль для бд
POSTGRES_DB=django # Название вашей бд
DB_HOST=db # Стандартное значение - db
DB_PORT=5432 # Стандартное значение - 5432
SECRET_KEY=DJANGO_SECRET_KEY # Ваш секретный ключ Django
DEBUG=False # True - включить Дебаг. Или оставьте пустым для False
IS_LOGGING=False # True - включить Логирование. Или оставьте пустым для False
ALLOWED_HOSTS=127.0.0.1 # Список адресов, разделенных пробелами
# Помните, если вы выставляете DEBUG=False, то необходимо будет настроить список ALLOWED_HOSTS.
# 127.0.0.1 является стандартным значением. Без пробелов и иных символов.В директории infra проекта находится файл docker-compose.yml, с помощью которого вы можете запустить проект локально в Docker контейнерах.
Находясь в директории infra выполните следующую команду:
Примечание. Если нужно - добавьте в конец команды флаг -d для запуска в фоновом режиме.
sudo docker compose -f docker-compose.yml upОна сбилдит Docker образы и запустит backend, frontend, СУБД и Nginx в отдельных Docker контейнерах.
Выполните миграции в контейнере с backend:
sudo docker compose -f docker-compose.yml exec tastyverse-backend python manage.py migrateСоберите статику backend'a:
sudo docker compose -f docker-compose.yml exec tastyverse-backend python manage.py collectstaticПо завершении всех операции проект будет запущен и доступен по адресу http://127.0.0.1/
Для остановки Docker контейнеров, находясь в директории infra выполните следующую команду:
sudo docker compose -f docker-compose.yml downЛибо просто завершите работу Docker Compose в терминале, в котором вы его запускали, сочетанием клавиш CTRL+C.
В проекте уже настроен Workflow для GitHub Actions.
Ваш GitHub Actions самостоятельно запустит:
- 🧪 Тесты: Запускаются тесты для вашего проекта.
- 🏗️ Сборку образов: Git Action создает Docker-образы вашего приложения.
- 🚀 Деплой: Образы отправляются на ваш репозиторий DockerHub, проект деплоится на сервер.
- ✉️ Уведомление: В случае успеха вы получите уведомление в Telegram.
Форкните репозиторий, перейдите в GitHub в настройки репозитория — Settings, найдите на панели слева пункт Secrets and Variables, перейдите в Actions, нажмите New repository secret.
Создайте следующие ключи:
Примечание. При подключении к вашему удалённому серверу воркер GitHub Actions создаст .env файл, создаст БД и запустит контейнер с backend'ом, используя эти константы.
# Общие секреты
DOCKER_USERNAME (Ваш логин в DockerHub)
DOCKER_PASSWORD (Ваш пароль в DockerHub)
HOST (IP адрес вашего удалённого сервера)
USER (Логин вашего удалённого сервера)
SSH_KEY (SSH ключ вашего удалённого сервера)
SSH_PASSPHRASE (Пароль вашего удалённого сервера)
TELEGRAM_TO (Ваш ID пользователя в Telegram)
TELEGRAM_TOKEN (Токен вашего бота в Telegram)
# PostgreSQL
POSTGRES_USER(Ваше имя пользователя для бд)
POSTGRES_PASSWORD(Ваш пароль для бд)
POSTGRES_DB(Название вашей бд)
DB_HOST(Адрес бд. Стандартное значение - db)
DB_PORT(Порт бд. Стандартное значение - 5432)
# Django
SECRET_KEY(Ваш секретный ключ Django)
DEBUG(Вкл/выкл DEBUG)
IS_LOGGING(Вкл/выкл Логирование)
ALLOWED_HOSTS(Список адресов, разделенных пробелами)
Внимание! Для корректного отображения изображений не забудьте помимо localhost и 127.0.0.1 добавить в ALLOWED_HOSTS доменное имя вашего сайта.
Пример PostgreSQL и Django констант из .env файла:
POSTGRES_USER=django_user # Ваше имя пользователя для бд
POSTGRES_PASSWORD=django # Ваш пароль для бд
POSTGRES_DB=django # Название вашей бд
DB_HOST=db # Стандартное значение - db
DB_PORT=5432 # Стандартное значение - 5432
SECRET_KEY=DJANGO_SECRET_KEY # Ваш секретный ключ Django
DEBUG=False # True - включить Дебаг. Или оставьте пустым для False
IS_LOGGING=False # True - включить Логирование. Или оставьте пустым для False
ALLOWED_HOSTS=127.0.0.1 # Список адресов, разделенных пробеламиВнимание! Дальнейшие действия подразумевают что на вашем удалённом сервере Nginx установлен и настроен как прокси-сервер. Изначально Nginx в Docker-контейнере слушает порт 8500.
В локальном проекте замените в файле docker-compose.production.yml названия образов в соответствии с вашим логином на DockerHub в нижнем регистре (Например your_name/tastyverse_backend)
Аналогично измените названия образов и в файле main.yml, который находится в директории /.github/workflows/.
Подключитесь к вашему удалённому серверу любым удобным способом. Создайте в домашней директории директорию с названием tastyverse и перейдите в неё.
mkdir tastyverseГотово.
Весь процесс автоматизирован! Как только вы инициируете коммит на локальной машине и отправите изменения на GitHub, GitHub Actions берет дело в свои руки:
git add .git commit -m "Ваше сообщение для коммита."git pushПосле успешной отправки изменений перейдите в своём репозитории на GitHub во вкладку Actions. Вы увидите процесс работы Actions. После окончания работы воркера в ваш Telegram придёт сообщение от бота:
Деплой проекта TastyVerse успешно выполнен!
Данное сообщение означает что проект успешно запущен на сервере, проведены миграции и собрана статика backend'а.
После этого можно вернуться на удалённый сервер, в директорию tastyverse и создать суперпользователя:
sudo docker compose -f docker-compose.production.yml exec backend python manage.py createsuperuserВнимание! : Для полноценной работы проекта на вашем удалённом сервере должен быть установлен, настроен и запущен Nginx. Удостоверьтесь что в конфиге по вашему доменному имени настроена переадресация всех запросов на 127.0.0.1:8500 и добавлена переадресация заголовков.
Чтобы проект отвечал базовым стандартам безопасности необходимо настроить SSL сертификат.
Установите certbot:
sudo apt install snapdsudo snap install core; sudo snap refresh coresudo snap install --classic certbotsudo ln -s /snap/bin/certbot /usr/bin/certbotЗапустите sertbot и получите свой SSL сертификат:
sudo certbot --nginxПосле перезапустите Nginx:
sudo systemctl reload nginxsudo certbot certificatesПримечание. SSL-сертификаты от Let's Encrypt действительны в течение 90 дней. Их нужно постоянно обновлять. Если вы не хотите делать это самостоятельно, вы можете настроить автоматическое обновление сертификата с помощью команды ниже.
sudo certbot renew --dry-runТеперь вы можете получить доступ к сайту по его доменному имени.
Как только убедитесь, что все рецепты отображаются корректно и без проблем, вы можете начать приглашать пользователей делиться своими кулинарными шедеврами.
Максим Головин
Вы можете заглянуть в другие мои репозитории в моем профиле GitHub.
Нажмите здесь.
Project link: TastyVerse
Ищете Русскую версию? Вам сюда --> click или листайте вверх.
TastyVerse provides the following features:
-
Adding and editing recipes: Create beautifully designed recipes, add photos of your dishes and tell others how to cook it step by step.
-
Search for recipes: Search for recipes by tags and authors.
-
Save to Favorites: Add your favorite recipes to your favorites collection to easily find them in the future.
-
Shopping List: Create a shopping list based on the ingredients needed to prepare selected dishes and save it. Later you will be able to download this list in PDF format and print it out so that you don't forget anything when going to the store.
-
Subscribe to authors: You can subscribe to authors whose recipes inspire you to always be aware of their new culinary ideas.
The repository includes two files docker-compose.yml and docker-compose.production.yml, which allows you to deploy the project on local or remote servers.
This instruction implies that Git, Python 3.10, pip package manager, Docker, Docker Compose and python3-venv virtual environment utility are already installed on your local/remote server.
The project provides the ability to run SQLite3 and PostgreSQL databases. The database is selected by changing the DEBUG value to True or False. True = SQLite3, False = PostgreSQL.
Detailed launch instructions can be found below.
Clone the project from the repository:
git clone https://github.com/PrimeStr/tastyverse-project-react.gitGo to the project directory:
cd tastyverse-project-react/Go to the infra directory and create the .env file:
cd infra/nano .envAdd the lines contained in the .env.example file and substitute your values.
Example from .env file:
# DB is selected automatically based on the DEBUG constant. If DEBUG = True, SQLite3 is used.
# If DEBUG = False, PostgreSQL is used.
POSTGRES_USER=django_user # Your db username
POSTGRES_PASSWORD=django # Your db password
POSTGRES_DB=django # Name of your database
DB_HOST=db # The standard value is db
DB_PORT=5432 # The standard value is 5432
SECRET_KEY=DJANGO_SECRET_KEY # Your Django Secret Key
DEBUG=False # True - enable Debug. Or leave it empty for False
IS_LOGGING=False # True - enable Logging. Or leave it empty for False
ALLOWED_HOSTS=127.0.0.1 # A list of addresses separated by spaces
# Remember, if you set DEBUG=False, you will need to configure the ALLOWED_HOSTS list.
# 127.0.0.1 is the standard value. Without spaces or other characters.The infra directory of the project contains the docker-compose.yml file, with which you can run the project locally in Docker containers.
While in the infra directory, run the following command:
Note. If necessary, add the -d flag to the end of the command to run it in the background.
sudo docker compose -f docker-compose.yml upIt will build Docker images and run backend, frontend, DBMS and Nginx in separate Docker containers.
Perform migrations in a container with a backend:
sudo docker compose -f docker-compose.yml exec tastyverse-backend python manage.py migrateCollect backend static:
sudo docker compose -f docker-compose.yml exec tastyverse-backend python manage.py collectstaticUpon completion of all operations, the project will be launched and available at http://127.0.0.1/
To stop Docker containers while in the infra directory, run the following command:
sudo docker compose -f docker-compose.yml downOr simply shut down Docker Compose in the terminal in which you launched it, using the keyboard shortcut CTRL+C.
Workflow for GitHub Actions is already configured in the project.
Your GitHub Actions will independently launch:
- 🧪 Tests: Run tests for your project.
- 🏗️ Image Assembly: Get Action creates Docker images of your application.
- 🚀 Deployment: Images are sent to your DockerHub repository, the project is deployed to the server.
- ✉️ Notification: If successful, you will receive a notification in Telegram.
Fork the repository, go to GitHub in the repository settings — Settings, find the item on the left panel Secrets and Variables, go to Actions, click New repository secret.
Create the following keys:
Note. When connecting to your remote server GitHub Actions worker will create a .env file, create a database and launch a container with a backend, using these constants.
# Shared secrets
DOCKER_USERNAME (Your login in DockerHub)
DOCKER_PASSWORD (Your password in DockerHub)
HOST (IP address of your remote server)
USER (Login of your remote server)
SSH_KEY (SSH key of your remote server)
SSH_PASSPHRASE (Password of your remote server)
TELEGRAM_TO (Your user ID in Telegram)
TELEGRAM_TOKEN (Token of your bot in Telegram)
# PostgreSQL
POSTGRES_USER (Your db username)
POSTGRES_PASSWORD (Your db password)
POSTGRES_DB (Your DB name)
DB_HOST (Db address. The standard value is db)
DB_PORT (Db port. The standard value is 5432)
# Django
SECRET_KEY (Your Django Secret key)
DEBUG (On/Off DEBUG)
IS_LOGGING (On/Off Logging)
ALLOWED_HOSTS (A list of addresses separated by spaces)
Attention! For the correct display of images, do not forget to add the domain name of your site to ALLOWED_HOSTS in addition to localhost and 127.0.0.1.
Example of PostgreSQL and Django constants from .env file:
POSTGRES_USER=django_user # Your db username
POSTGRES_PASSWORD=django # Your db password
POSTGRES_DB=django # Name of your DB
DB_HOST=db # Standard value - db
DB_PORT=5432 # The standard value is 5432
SECRET_KEY=DJANGO_SECRET_KEY # Your Django Secret Key
DEBUG=False # True - enable Debug. Or leave it empty for False
IS_LOGGING=False # True - enable Logging. Or leave it empty for False
ALLOWED_HOSTS=127.0.0.1 # A list of addresses separated by spacesAttention! Further actions imply that on your remote server Nginx is installed and configured as a proxy server. Initially Nginx in Docker container listens on port 8500.
In the local project, replace the image names in the docker-compose.production.yml file in accordance with your login to DockerHub in lowercase (For example your_name/tastyverse_backend)
Similarly, change the names of the images in the main.yml file, which is located in the /.github/workflows/ directory.
Connect to your remote server in any convenient way. Create a directory in your home directory with the name tastyverse and go to it.
mkdir tastyverseDone.
The whole process is automated! As soon as you initiate a commit on the local machine and send the changes to GitHub, GitHub Actions takes matters into its own hands:
git add .git commit -m "Your message for the commit."git pushAfter successfully submitting the changes, go to the Actions tab in your GitHub repository. You will see the Actions process. After the end of the worker's work, a message from the bot will come to your Telegram:
Деплой проекта TastyVerse успешно выполнен!
This message means that the project has been successfully launched on the server, migrations have been performed and backend static has been collected.
After that, you can return to the remote server, to the tastyverse directory and create a superuser:
sudo docker compose -f docker-compose.production.yml exec backend python manage.py createsuperuserAttention! : For the project to work properly, Nginx must be installed, configured and running on your remote server. Make sure that the config for your domain name is configured to forward all requests to 127.0.0.1:8500 and header forwarding is added.
In order for the project to meet the basic security standards, you need to configure SSL certificate.
Install certbot:
sudo apt install snapdsudo snap install core; sudo snap refresh coresudo snap install --classic certbotsudo ln -s /snap/bin/certbot /usr/bin/certbotLaunch sertbot and get your SSL certificate:
sudo certbot --nginxThen restart Nginx:
sudo systemctl reload nginxsudo certbot certificatesNote. SSL certificates from Let's Encrypt are valid for 90 days. They need to be constantly updated. If you don't want to do this yourself, you can configure automatic certificate renewal using the command below.
sudo certbot renew --dry-runNow you can access the site by its domain name.
As soon as you make sure that all recipes are displayed correctly and without problems, you can start inviting users to share their culinary masterpieces.
Maxim Golovin
You can take a look at my other repositories in my GitHub profile.
Click here.