Сайт доставки еды Star Burger

Это сайт сети ресторанов Star Burger. Здесь можно заказать превосходные бургеры с доставкой на дом.

Сеть Star Burger объединяет несколько ресторанов, действующих под единой франшизой. У всех ресторанов одинаковое меню и одинаковые цены. Просто выберите блюдо из меню на сайте и укажите место доставки. Мы сами найдём ближайший к вам ресторан, всё приготовим и привезём.

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

Второй интерфейс предназначен для менеджера. Здесь происходит обработка заказов. Менеджер видит поступившие новые заказы и первым делом созванивается с клиентом, чтобы подтвердить заказ. После оператор выбирает ближайший ресторан и передаёт туда заказ на исполнение. Там всё приготовят и сами доставят еду клиенту.

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

Как запустить dev-версию сайта

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

Как собрать бэкенд

Скачайте код:

git clone https://github.com/devmanorg/star-burger.git

Перейдите в каталог проекта:

cd star-burger

Установите Python, если этого ещё не сделали.

Проверьте, что python установлен и корректно настроен. Запустите его в командной строке:

python --version

Важно! Версия Python должна быть не ниже 3.6.

Возможно, вместо команды python здесь и в остальных инструкциях этого README придётся использовать python3. Зависит это от операционной системы и от того, установлен ли у вас Python старой второй версии.

В каталоге проекта создайте виртуальное окружение:

python -m venv venv

Активируйте его. На разных операционных системах это делается разными командами:

• Windows: .\venv\Scripts\activate
• MacOS/Linux: source venv/bin/activate

Установите зависимости в виртуальное окружение:

pip install -r requirements.txt

Определите переменную окружения SECRET_KEY. Создать файл .env в каталоге star_burger/ и положите туда такой код:

SECRET_KEY=django-insecure-0if40nf4nf93n4

Создайте файл базы данных SQLite и отмигрируйте её следующей командой:

python manage.py migrate

Запустите сервер:

python manage.py runserver

Откройте сайт в браузере по адресу http://127.0.0.1:8000/. Если вы увидели пустую белую страницу, то не пугайтесь, выдохните. Просто фронтенд пока ещё не собран. Переходите к следующему разделу README.

Собрать фронтенд

Откройте новый терминал. Для работы сайта в dev-режиме необходима одновременная работа сразу двух программ runserver и parcel. Каждая требует себе отдельного терминала. Чтобы не выключать runserver откройте для фронтенда новый терминал и все нижеследующие инструкции выполняйте там.

Установите Node.js, если у вас его ещё нет.

Проверьте, что Node.js и его пакетный менеджер корректно установлены. Если всё исправно, то терминал выведет их версии:

nodejs --version
# v12.18.2
# Если ошибка, попробуйте node:
node --version
# v12.18.2

npm --version
# 6.14.5

Версия nodejs должна быть не младше 10.0. Версия npm не важна. Как обновить Node.js читайте в статье: How to Update Node.js.

Перейдите в каталог проекта и установите пакеты Node.js:

cd star-burger
npm ci --dev

Команда npm ci создаст каталог node_modules и установит туда пакеты Node.js. Получится аналог виртуального окружения как для Python, но для Node.js.

Помимо прочего будет установлен Parcel — это упаковщик веб-приложений, похожий на Webpack. В отличии от Webpack он прост в использовании и совсем не требует настроек.

Теперь запустите сборку фронтенда и не выключайте. Parcel будет работать в фоне и следить за изменениями в JS-коде:

./node_modules/.bin/parcel watch bundles-src/index.js --dist-dir bundles --public-url="./"

Если вы на Windows, то вам нужна та же команда, только с другими слешами в путях:

.\node_modules\.bin\parcel watch bundles-src/index.js --dist-dir bundles --public-url="./"

Дождитесь завершения первичной сборки. Это вполне может занять 10 и более секунд. О готовности вы узнаете по сообщению в консоли:

✨  Built in 10.89s

Parcel будет следить за файлами в каталоге bundles-src. Сначала он прочитает содержимое index.js и узнает какие другие файлы он импортирует. Затем Parcel перейдёт в каждый из этих подключенных файлов и узнает что импортируют они. И так далее, пока не закончатся файлы. В итоге Parcel получит полный список зависимостей. Дальше он соберёт все эти сотни мелких файлов в большие бандлы bundles/index.js и bundles/index.css. Они полностью самодостаточно и потому пригодны для запуска в браузере. Именно эти бандлы сервер отправит клиенту.

Теперь если зайти на страницу http://127.0.0.1:8000/, то вместо пустой страницы вы увидите:

Каталог bundles в репозитории особенный — туда Parcel складывает результаты своей работы. Эта директория предназначена исключительно для результатов сборки фронтенда и потому исключёна из репозитория с помощью .gitignore.

Сбросьте кэш браузера Ctrl-F5. Браузер при любой возможности старается кэшировать файлы статики: CSS, картинки и js-код. Порой это приводит к странному поведению сайта, когда код уже давно изменился, но браузер этого не замечает и продолжает использовать старую закэшированную версию. В норме Parcel решает эту проблему самостоятельно. Он следит за пересборкой фронтенда и предупреждает JS-код в браузере о необходимости подтянуть свежий код. Но если вдруг что-то у вас идёт не так, то начните ремонт со сброса браузерного кэша, жмите Ctrl-F5.

Как запустить prod-версию сайта

Собрать фронтенд:

./node_modules/.bin/parcel build bundles-src/index.js --dist-dir bundles --public-url="./"

Настроить бэкенд: создать файл .env в каталоге star_burger/ со следующими настройками:

• DEBUG — дебаг-режим. Поставьте False.
• SECRET_KEY — секретный ключ проекта. Он отвечает за шифрование на сайте. Например, им зашифрованы все пароли на вашем сайте.
• ALLOWED_HOSTS — см. документацию Django
• YANDEX_API - Yandex geocoder API
• ROLLBAR_ACCESS_TOKEN - токен сервиса логирования Rollbar
• ROLLBAR_ENVIRONMENT - окружение production или development
• POSTGRESQL_URL - параметры подключения к базе данных Postgres в формате postgres://USER:PASSWORD@HOST:PORT/DBNAME
• DOCKER_APP_ENVIRONMENT- окружение для докера: dev - для разработки, prod - для production-сервера.

Автоматическая сборка проекта на сервере

Автоматическая сборка проекта на сервере представлена в виде bash-скрипта deploy_star_burger.sh, который нужно запустить на сервере.
Для этого сначала нужно настроить sudo на сервере, чтобы избежать запрос пароля для команд, требующих sudo.\

1. Создайте файл starburger_commands в каталоге /etc/sudoers.d/

nano /etc/sudoers.d/nginx_reload

со следующим содержимым:

Defaults:username !requiretty
Cmnd_Alias NGINX_RELOAD = /usr/bin/systemctl reload nginx.service
Cmnd_Alias STARBURGER_RESTART = /usr/bin/systemctl restart starburger.service
username ALL=(ALL) NOPASSWD: NGINX_RELOAD, STARBURGER_RESTART

где username - имя пользователя, под которым запускается скрипт (замените на своего пользователя) 2. Скопируйте скрипт deploy_star_burger.sh на сервер, укажите в переменной ROLLBAR_ACCESS_TOKEN токен сервиса Rollbar и запустите скрипт:

./deploy_star_burger.sh

Сборка проекта в докере

Проект может быть собран в dev-режиме для разработки, и в prod-режиме для production-сервера. Оба режима используют базу данных postgres.
Для базы данных postgres создайте файл .env_db_pgsql в коневой папке проекта со следующими переменными окружения:

• POSTGRES_USER - пользователь базы данных
• POSTGRES_PASSWORD - пароль пользователя
• POSTGRES_DB - название базы данных

В переменной окружения POSTGRESQL_URL в качестве адреса базы данных укажите postgres.

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

docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

Проект в dev-режиме будет доступен по адресу http://127.0.0.1:8000

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

docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build

Проект в prod-режиме будет доступен по адресу http://127.0.0.1

Адрес сайта

Демо-версия сайта доступна по адресу starburger.systekam.ru

Цели проекта

Код написан в учебных целях — это урок в курсе по Python и веб-разработке на сайте Devman. За основу был взят код проекта FoodCart.

Где используется репозиторий:

• Второй и третий урок учебного модуля Django