Skip to content

Commit 5bc06af

Browse files
authoredDec 13, 2022
Sync with template (#6)
* Sync with template * Update readme
1 parent 0fc9321 commit 5bc06af

File tree

5 files changed

+22
-134
lines changed

5 files changed

+22
-134
lines changed
 

‎Makefile

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ sync:
44
npm init @novomanu/project-cli
55

66
rebuild_backend:
7-
docker-compose down -v
8-
docker-compose run backend npm run rebuild
7+
docker compose down -v
8+
docker compose run backend npm run rebuild
99

1010
start_project:
11-
docker-compose down -v
12-
docker-compose up --build
11+
docker compose down -v
12+
docker compose up --build
1313

1414
run_server:
15-
docker-compose down -v
16-
docker-compose up backend --build
15+
docker compose down -v
16+
docker compose up backend --build
1717

1818
run_tests:
1919
cd frontend; echo "...Starting frontend tests" && \

‎README.md

+5-112
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,11 @@
22

33
## Начальные требования
44
- Docker
5-
- Docker-compose
65
- NodeJS >= 16
76

87
## Docker установка
98
https://docs.docker.com/get-docker/
109

11-
https://dker.ru/docs/ (рус)
12-
13-
## Docker-compose установка
14-
https://docs.docker.com/compose/install/
15-
1610
## Node js установка
1711
Мы рекоммендуем использовать Node Version Manager для удобного управления версиями node.js
1812

@@ -61,7 +55,7 @@ make --version
6155
В директории `frontend` возможно выполнить следующие скрипты:
6256

6357
```
64-
npm run serve - запуск проекта (только клиент) в режиме разработки
58+
npm run dev - запуск проекта (только клиент) в режиме разработки
6559
npm run build - создание продакшн сборки проекта
6660
npm run test:unit - запуск юнит тестов
6761
npm run lint - запуск линтера
@@ -99,13 +93,13 @@ npm run lint - запуск линтера
9993

10094
- Сборка проекта
10195

102-
`$ docker-compose build`
96+
`$ docker compose build`
10397

10498
### Запуск проекта с Docker
10599

106-
`$ docker-compose down -v`
100+
`$ docker compose down -v`
107101

108-
`$ docker-compose up`
102+
`$ docker compose up`
109103

110104
Сервер будет доступен по адресу `localhost:3000`
111105

@@ -141,7 +135,7 @@ cd frontend && npm run dev
141135

142136
## Вход для авторизированного пользователя
143137

144-
Мы создали готового пользователя и разместили его в нашей базе данных. Для входа в систему используйте следующие данные:
138+
Мы создали готового пользователя и разместили его в нашей базе данных. Для входа (логина) в систему используйте следующие данные:
145139

146140
```
147141
email: user@example.com
@@ -189,104 +183,3 @@ npm start
189183
Шаблон и вёрстка будут доступны по адресу: `http://localhost:9999`.
190184

191185
Вёрстку можно посмотреть в директории `template/src`.
192-
193-
## Развертывание проекта на Windows 10 Home Edition (build 1909)
194-
195-
### Устанавливаем подсистему Windows для Linux (WSL) в Windows 10
196-
197-
Для установки требуется Windows 10 версии 1903 или более поздняя со сборкой 18362 или более поздней версии.
198-
199-
Устанавливаем WSL прямо по шагам, указанным [в этой статье](https://docs.microsoft.com/ru-ru/windows/wsl/install-win10#manual-installation-steps).
200-
201-
На шаге 6 «Установка дистрибутива Linux по выбору» для Windows 10 с русским языком в Microsoft Store нет ничего. Поэтому используем ссылки на страницы Microsoft Store ниже под картинкой: устанавливаем Ubuntu 18.04 LTS. Далее продолжаем установку по инструкции. В конце установки Ubuntu рекомендуется закрепить ярлык на начальном экране (при нажатии на «Пуск»).
202-
203-
Устанавливать Терминал Windows необязательно, так как удобнее использовать терминалы из VSCode.
204-
205-
### Настраиваем Ubuntu 18.04 LTS
206-
207-
Подключаем и обновляем репозиторий:
208-
209-
```
210-
sudo add-apt-repository universe
211-
sudo apt-get update
212-
```
213-
214-
Устанавливаем Python 3 и его систему управления пакетами pip:
215-
216-
```
217-
sudo apt install python3
218-
python3 --version
219-
220-
sudo apt install -y python3-pip
221-
pip3 --version
222-
```
223-
224-
Устанавливаем make:
225-
226-
```
227-
sudo apt install make
228-
make --version
229-
```
230-
231-
### Устанавливаем/обновляем NodeJS
232-
233-
Скачиваем и устанавливаем LTS версию v16.15.0 [здесь](https://nodejs.org/dist/v16.15.0/node-v16.15.0-x64.msi).
234-
235-
Перезагружаем ОС.
236-
237-
### Устанавливаем Docker
238-
239-
Скачиваем и устанавливаем Docker Desktop on Windows.
240-
241-
Перезагружаем ОС.
242-
243-
Docker-compose уже включён в Docker Desktop on Windows. Поэтому дополнительно его устанавливать не нужно.
244-
245-
### Настраиваем Docker
246-
247-
В трее на значке Docker нажимаем правой кнопкой мыши и во всплывающем меню выбираем пункт Settings.
248-
249-
Переходим в Resources/WSL INTEGRATION и включаем на ней всё.
250-
251-
На Experimental Features оставляем параметр «Use Docker Compose V2» выключенным - будет использоваться стабильная версия 1.29
252-
253-
### Запускаем VS Code
254-
255-
При первом запуске VS Code после установки Docker будет предложено установить расширение Docker для VS Code.
256-
257-
Открываем проект Pizza (`Ctrl + K`, `Ctrl + O`).
258-
259-
### Установка Frontend
260-
261-
В терминале VS Code переключаемся на оболочку PowerShell.
262-
263-
* Перейти в директорию `cd frontend`
264-
* Установить зависимости `npm ci`
265-
266-
### Установка Backend
267-
268-
В терминале VS Code в оболочке PowerShell:
269-
270-
* Вернуться в корневой каталог проекта `cd ..`
271-
* Перейти в директорию `cd backend`
272-
* Установить зависимости `npm ci`
273-
* Вернуться в корневой каталог проекта `cd ..`
274-
275-
### Docker установка проекта
276-
277-
В терминале VS Code в оболочке PowerShell:
278-
279-
* Выполнить команду `docker-compose build`
280-
281-
В терминале VS Code переключаемся на оболочку Ubuntu-18.04 (WSL):
282-
283-
* Запустить проект с помощью команды `make start_project`
284-
* Для остановки нажать `Ctrl + C`
285-
286-
### Запуск и просмотр готовой вёрстки проекта
287-
288-
В терминале VS Code переключаемся на оболочку PowerShell:
289-
290-
* Находясь в корневом каталоге проекта, перейдите в директорию template: `cd template`
291-
* Установите зависимости, выполнив команду `npm ci`
292-
* Запустите проект командой `npm start`

‎frontend/README.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,34 @@
1-
# vue3
1+
# Vue 3
22

3-
This template should help get you started developing with Vue 3 in Vite.
4-
5-
## Recommended IDE Setup
3+
## Рекоммендации по настройке IDE
64

75
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
86

9-
## Customize configuration
10-
11-
See [Vite Configuration Reference](https://vitejs.dev/config/).
12-
13-
## Project Setup
7+
## Установка зависимостей
148

159
```sh
1610
npm install
1711
```
1812

19-
### Compile and Hot-Reload for Development
13+
### Запуск проекта
2014

2115
```sh
2216
npm run dev
2317
```
2418

25-
### Compile and Minify for Production
19+
### Сборка проекта
2620

2721
```sh
2822
npm run build
2923
```
3024

31-
### Run Unit Tests with [Vitest](https://vitest.dev/)
25+
### Запуск тестов с помощью [Vitest](https://vitest.dev/)
3226

3327
```sh
3428
npm run test:unit
3529
```
3630

37-
### Lint with [ESLint](https://eslint.org/)
31+
### Линт с помощью [ESLint](https://eslint.org/)
3832

3933
```sh
4034
npm run lint

‎frontend/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
"build": "vite build",
77
"preview": "vite preview --port 5050",
88
"test:unit": "vitest",
9-
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore",
10-
"test": "vitest"
9+
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"
1110
},
1211
"dependencies": {
1312
"axios": "^1.1.3",

‎mucli.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
{
2-
"templateId": "html-academy-vue3-pizza"
2+
"template": {
3+
"id": "html-academy-vue3-pizza"
4+
}
35
}

0 commit comments

Comments
 (0)
Please sign in to comment.