forked from ddrilling/asb_cloud_front
3af90800ff
* TODO.md удалён за ненадобностью * В index.html добавлено более подробное описание цветовых тем * Части методов utils добавлена документация, явно указаны типа данных
62 lines
2.8 KiB
Markdown
Executable File
62 lines
2.8 KiB
Markdown
Executable File
|
||
# Проект веб части ASB cloud
|
||
|
||
# Порядок запуска
|
||
## 1. Установка пакетов
|
||
Для запуска установки необходимо иметь уже установленый [NPM](https://www.npmjs.com).
|
||
|
||
Установка выполняется одной командой:
|
||
```bash
|
||
npm i
|
||
```
|
||
|
||
## 2. Автогенерация сервисов
|
||
Для корректной работы веб-приложения необходимо наличие сервисов работы с RestAPI.
|
||
|
||
Для их автогенерации требуется уже запущенная серверная часть.
|
||
|
||
Автогенерацию можно запустить с помощью уже прописанных в [package.json](package.json) скриптов, либо вручную.
|
||
|
||
Если сервер запущен на текущей машине достаточно написать:
|
||
```bash
|
||
npm run update_openapi
|
||
```
|
||
|
||
Для получения сервисов с основного сервера:
|
||
```bash
|
||
npm run update_openapi_server
|
||
```
|
||
|
||
или же ручной вариант:
|
||
```bash
|
||
npx openapi -i http://{IP_ADDRESS}:{PORT}/swagger/v1/swagger.json -o src/services/api
|
||
```
|
||
|
||
где ***IP_ADDRESS*** и ***PORT*** это соответственно IP-адрес и порт сервера.
|
||
|
||
На данный момент имеются следующие IP-адреса:
|
||
| IP-адрес | Описание |
|
||
|:-|:-|
|
||
| 127.0.0.1:5000 | Локальный адрес вашей машины (привязан к `update_openapi`) |
|
||
| 192.168.1.70:5000 | Локальный адрес development-сервера (привязан к `update_openapi_server`) |
|
||
| 46.146.209.148:89 | Внешний адрес development-сервера |
|
||
| 46.146.209.148 | Внешний адрес production-сервера |
|
||
|
||
## 3. Компиляция production-версии приложения
|
||
После выполнения вышеописанных пунктов приложение готово к компиляции.
|
||
|
||
Для компиляции досточно выполнить команду:
|
||
```bash
|
||
npm run build
|
||
```
|
||
|
||
После завершения этой команды скомпилированное приложение будет находиться в появившейся директории [build/](build/).
|
||
|
||
## 4. Запуск development-версии приложения
|
||
В [package.json](package.json) необходимо проверить и при необходимости изменить значение в поле ***proxy*** (пара адрес-порт сервера с RestAPI) на актуальное.
|
||
|
||
После чего выполнить запуск командой:
|
||
```bash
|
||
npm start
|
||
```
|