Это сайт сети ресторанов Star Burger. Здесь можно заказать превосходные бургеры с доставкой на дом.
Сеть Star Burger объединяет несколько ресторанов, действующих под единой франшизой. У всех ресторанов одинаковое меню и одинаковые цены. Просто выберите блюдо из меню на сайте и укажите место доставки. Мы сами найдём ближайший к вам ресторан, всё приготовим и привезём.
На сайте есть три независимых интерфейса. Первый — это публичная часть, где можно выбрать блюда из меню, и быстро оформить заказ без регистрации и SMS.
Второй интерфейс предназначен для менеджера. Здесь происходит обработка заказов. Менеджер видит поступившие новые заказы и первым делом созванивается с клиентом, чтобы подтвердить заказ. После оператор выбирает ближайший ресторан и передаёт туда заказ на исполнение. Там всё приготовят и сами доставят еду клиенту.
Третий интерфейс — это админка. Преимущественно им пользуются программисты при разработке сайта. Также сюда заходит менеджер, чтобы обновить меню ресторанов Star Burger.
Для запуска сайта нужно запустить одновременно бэкенд и фронтенд, в двух терминалах.
Скачайте код:
git clone https://github.com/devmanorg/star-burger.git
Установите Python, если этого ещё не сделали.
Проверьте, что python
установлен и корректно настроен. Запустите его в командной строке:
python --version
Важно! Версия Python должна быть не ниже 3.6.
Возможно, вместо команды python
здесь и в остальных инструкциях этого README придётся использовать python3
. Зависит это от операционной системы и от того, установлен ли у вас Python старой второй версии.
Установите virtualenv
apt install python3-virtualenv
В каталоге проекта создайте виртуальное окружение:
virtualenv venv
Активируйте его. На разных операционных системах это делается разными командами:
- Windows:
.\venv\Scripts\activate
- MacOS/Linux:
source venv/bin/activate
Перейдите в каталог проекта:
cd star-burger
Установите зависимости в виртуальное окружение:
pip install -r requirements.txt
Создайте файл базы данных 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
не важна.
Установите необходимые пакеты. В каталоге проекта запустите:
npm install --dev
Установите Parcel. Это упаковщик веб-приложений. Он похож на Webpack, но совсем не требует настроек:
npm install -g [email protected] # понадобятся права администратора `sudo`
Вам нужна именно версия 1.12.3. Проверьте, что parcel
установлен и его версию в командной строке:
parcel --version
Почти всё готово. Теперь запустите сборку фронтенда и не выключайте. Parcel будет работать в фоне и следить за изменениями в JS-коде:
parcel watch bundles-src/index.js -d 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.
Обновите менеджер пакетов:
apt-get update
Установить pip:
apt-get install python3-pip
Установить virtualenv
apt install python3-virtualenv
Установить СУБД:
apt-get install postgresql
проверить, что СУБД успешно установлена и доступна для подключения:
pg_isready
Создать базу данных:
su - postgres
psql
ALTER USER postgres PASSWORD '';
CREATE DATEBASE starburger;
\q
exit
Установите nginx для работы со статикой и media:
apt-get install nginx
Настройте nginx для работы со статикой и media:
rm /etc/nginx/sites-enabled/default
nano /etc/nginx/sites-enabled/starburger
server {
listen 80 default;
location / {
include '/etc/nginx/proxy_params';
proxy_pass http://127.0.0.1:8080/;
}
location /media/ {
alias /opt/star-burger/media/;
}
location /static/ {
alias /opt/star-burger/staticfiles/;
}
}
Установите nodejs и npm:
apt-get install nodejs
apt-get install npm
Установите сертификаты:
snap install core
snap refresh core
snap install --classic certbot
ln -s /snap/bin/certbot /usr/bin/certbot
certbot --nginx
Настройте виртуальное окружение:
Создать файл .env
в каталоге star_burger/
со следующими настройками:
DEBUG
— дебаг-режим. ИспользуйтеTrue
для prod сервера, в остальных случаяхFalse
.DATABASE_URL
- строка подключения к базе данных, формата "postgres://user:[email protected]:5432/database"SECRET_KEY
— секретный ключ проекта. Он отвечает за шифрование на сайте. Например, им зашифрованы все пароли на вашем сайте. Не стоит использовать значение по-умолчанию, замените на своё.ALLOWED_HOSTS
— см. документацию DjangoYANDEX_API_KEY
— API ключ yandex геокодер, замените на своё.ROLLBAR_TOKEN
— Токен rollbar.ROLLBAR_ENVIRONMENT
— Определяет разработческая или прод. версия сайта. По умолчанию development.
Настройте сервисы для автоматического исполнения:
Скопируйте файлы *.service и *.timer в каталог /etc/systemd/system
systemctl enable *.service
В каталоге проекта создайте виртуальное окружение:
virtualenv venv
Запустите скрипт деплоя:
./deploy_starburger.sh
Координаты prod сервера, на котором расположен сайт:
SITE | https://star-burger.site/ |
---|---|
IP | 178.62.213.232 |
USER | root |
PORT | 22 |
DEPLOY SCRIPT | /opt/star-burger/deploy_starburger.sh |
Код написан в учебных целях — это урок в курсе по Python и веб-разработке на сайте Devman. За основу был взят код проекта FoodCart.
Где используется репозиторий:
- Второй и третий урок учебного модуля Django