From 5ba3628a9f327be42de8898fa6b2f4396d014bff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D0=B5=D1=80=D0=B3=D0=B5=D0=B9=20=D0=A2=D1=8F=D0=BF?= =?UTF-8?q?=D0=BA=D0=B8=D0=BD?= Date: Sun, 24 Mar 2024 03:27:03 +0300 Subject: [PATCH] Improved readme --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7dbbd59..6b792aa 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,32 @@ # Веб-вервис в докере с авто-деплоем на _Nginx_ и получением сертификатов _Letsencript_ -Всё делается через команды `make` +## Развертка для разработки +```SHELL +npm run dev +``` +_У вас должна быть установлена `node`. [Установка Node.js](https://nodejs.org/en/download)_ + +# Развертка в деплой +Развертка выполняется через команды в `Makefile` -### 1. Клонируем репозиторий: +## 1. Клонируем репозиторий: ```SHELL git clone git@github.com:SergTyapkin/vue-frontend-template.git ``` -### 2. Настраиваем вообще всё. +## 2. Настраиваем вообще всё. В самом начале нужно будет настроить `.env` файл, прописать правильный `DOMAIN_URL` ```SHELL cd vue-frontend-template -make all +make all # not just "make"! ```` - Всё. Наслаждаемся тем, что за нас всё сделали, установили докер, сайт раздаётся, сертификаты обновляются. Теперь `Github CI` сам будет проверять, собирается ли контейнер при **Pull Request**'ах, а при **Push**'ах в ветку `master` будет автоматически выполняться `make update` на сервере и обновлять деплой! -## Полный список действий скриптов +_После выполнения не забываем прописать переменные, значения которых команда выдала в консоль, в настройки окружения репозитория на Github, как это написано в пункте 3._ + +### Полный список действий скриптов 1. Устанавливает `docker`, если его ещё нет 2. Добавляет текущего пользователя в группу `Docker`, чтобы запускать его без `sudo` 3. Предлагает настроить `.env` файл @@ -28,7 +36,7 @@ make all 6. Создаёт пару SSH ключей, публичный добавляет в `~/.ssh/authorized_keys`, приватный выводит в консоль, его нужно добавить как секретную переменную среды `SSH_DEPLOY_KEY` в настройках Github. 7. Собирает приложение из последнего коммита в ветку `master`, запускает финальный docker-контейнер с ним -### 3. Установка переменных +## 3. Установка переменных 1. Заходим в `Settings` -> `Environments`, создаём новое окружение под названием `deploy` (важно). ![](/README_res/1.png) 2. Создаём внутри окружения все необходимые переменные. Их выведет `make all` после завершения выполнения, или можно прописать самому.