Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sync with template #6

Merged
merged 2 commits into from
Dec 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ sync:
npm init @novomanu/project-cli

rebuild_backend:
docker-compose down -v
docker-compose run backend npm run rebuild
docker compose down -v
docker compose run backend npm run rebuild

start_project:
docker-compose down -v
docker-compose up --build
docker compose down -v
docker compose up --build

run_server:
docker-compose down -v
docker-compose up backend --build
docker compose down -v
docker compose up backend --build

run_tests:
cd frontend; echo "...Starting frontend tests" && \
Expand Down
117 changes: 5 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,11 @@

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

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

https://dker.ru/docs/ (рус)

## Docker-compose установка
https://docs.docker.com/compose/install/

## Node js установка
Мы рекоммендуем использовать Node Version Manager для удобного управления версиями node.js

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

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

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

`$ docker-compose build`
`$ docker compose build`

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

`$ docker-compose down -v`
`$ docker compose down -v`

`$ docker-compose up`
`$ docker compose up`

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

Expand Down Expand Up @@ -141,7 +135,7 @@ cd frontend && npm run dev

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

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

```
email: [email protected]
Expand Down Expand Up @@ -189,104 +183,3 @@ npm start
Шаблон и вёрстка будут доступны по адресу: `http://localhost:9999`.

Вёрстку можно посмотреть в директории `template/src`.

## Развертывание проекта на Windows 10 Home Edition (build 1909)

### Устанавливаем подсистему Windows для Linux (WSL) в Windows 10

Для установки требуется Windows 10 версии 1903 или более поздняя со сборкой 18362 или более поздней версии.

Устанавливаем WSL прямо по шагам, указанным [в этой статье](https://docs.microsoft.com/ru-ru/windows/wsl/install-win10#manual-installation-steps).

На шаге 6 «Установка дистрибутива Linux по выбору» для Windows 10 с русским языком в Microsoft Store нет ничего. Поэтому используем ссылки на страницы Microsoft Store ниже под картинкой: устанавливаем Ubuntu 18.04 LTS. Далее продолжаем установку по инструкции. В конце установки Ubuntu рекомендуется закрепить ярлык на начальном экране (при нажатии на «Пуск»).

Устанавливать Терминал Windows необязательно, так как удобнее использовать терминалы из VSCode.

### Настраиваем Ubuntu 18.04 LTS

Подключаем и обновляем репозиторий:

```
sudo add-apt-repository universe
sudo apt-get update
```

Устанавливаем Python 3 и его систему управления пакетами pip:

```
sudo apt install python3
python3 --version

sudo apt install -y python3-pip
pip3 --version
```

Устанавливаем make:

```
sudo apt install make
make --version
```

### Устанавливаем/обновляем NodeJS

Скачиваем и устанавливаем LTS версию v16.15.0 [здесь](https://nodejs.org/dist/v16.15.0/node-v16.15.0-x64.msi).

Перезагружаем ОС.

### Устанавливаем Docker

Скачиваем и устанавливаем Docker Desktop on Windows.

Перезагружаем ОС.

Docker-compose уже включён в Docker Desktop on Windows. Поэтому дополнительно его устанавливать не нужно.

### Настраиваем Docker

В трее на значке Docker нажимаем правой кнопкой мыши и во всплывающем меню выбираем пункт Settings.

Переходим в Resources/WSL INTEGRATION и включаем на ней всё.

На Experimental Features оставляем параметр «Use Docker Compose V2» выключенным - будет использоваться стабильная версия 1.29

### Запускаем VS Code

При первом запуске VS Code после установки Docker будет предложено установить расширение Docker для VS Code.

Открываем проект Pizza (`Ctrl + K`, `Ctrl + O`).

### Установка Frontend

В терминале VS Code переключаемся на оболочку PowerShell.

* Перейти в директорию `cd frontend`
* Установить зависимости `npm ci`

### Установка Backend

В терминале VS Code в оболочке PowerShell:

* Вернуться в корневой каталог проекта `cd ..`
* Перейти в директорию `cd backend`
* Установить зависимости `npm ci`
* Вернуться в корневой каталог проекта `cd ..`

### Docker установка проекта

В терминале VS Code в оболочке PowerShell:

* Выполнить команду `docker-compose build`

В терминале VS Code переключаемся на оболочку Ubuntu-18.04 (WSL):

* Запустить проект с помощью команды `make start_project`
* Для остановки нажать `Ctrl + C`

### Запуск и просмотр готовой вёрстки проекта

В терминале VS Code переключаемся на оболочку PowerShell:

* Находясь в корневом каталоге проекта, перейдите в директорию template: `cd template`
* Установите зависимости, выполнив команду `npm ci`
* Запустите проект командой `npm start`
20 changes: 7 additions & 13 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,34 @@
# vue3
# Vue 3

This template should help get you started developing with Vue 3 in Vite.

## Recommended IDE Setup
## Рекоммендации по настройке IDE

[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).

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project Setup
## Установка зависимостей

```sh
npm install
```

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

```sh
npm run dev
```

### Compile and Minify for Production
### Сборка проекта

```sh
npm run build
```

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

```sh
npm run test:unit
```

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

```sh
npm run lint
Expand Down
3 changes: 1 addition & 2 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
"build": "vite build",
"preview": "vite preview --port 5050",
"test:unit": "vitest",
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore",
"test": "vitest"
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"
},
"dependencies": {
"axios": "^1.1.3",
Expand Down
4 changes: 3 additions & 1 deletion mucli.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"templateId": "html-academy-vue3-pizza"
"template": {
"id": "html-academy-vue3-pizza"
}
}