Open vAIR UI

Пользовательский интерфейс проекта Open vAIR UI

Установка

Для установки и запуска необходимо, чтобы был установлен Node.js v20 и выше

Порядок установки

1. Установить необходимые пакеты

Для этого выполнить команду установки:

npm install

2. Создать и настроить
   .env
   файл

Файл

должен находится в корне проекта

Можно создать копию

Необходимо указать URL API сервера в поле

Запуск

Запуск в режиме разработки

npm run dev

Сборка

Сборка с проверкой типов и проверкой eslint

Так же выполняет проверку типов

и статический анализ кода

npm run lint

npm run build

В случае наличия ошибки типов или предупреждений eslint сборка не будет выполнена

Сборка без проверки типов и проверки eslint

npm run build-only

Не рекомендуется к использованию, без особой причины

Проверка типов

npm run type-check

Статический анализ кода

npm run lint

Генерация типов API

Для генерации типов API используется пакет

Для обновления типов API нужно убедиться, что в

файле в поле

GENERATE_API_SCHEMA_URL

указан корректный URL JSON до файла

openapi.json

, который отдаёт Swagger

Далее выполнить команду

npm run generate-api

Описание структуры проекта

(папка src)

- API, кофигурация axios, сгенерированные API типы

- Файлы шрифтов, css

- библиотека общих компонентов

- вспомогательные функции

- файлы локализаций

- компоненты приложения, разбитые по модулям

- роутер приложения

- стор приложения, экшены, мутации, стэйт

- файлы конфигурации цветовых тем приложения

- глобальные описания некоторых типов