Open vAIR UI

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

Установка

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

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

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

npm install

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

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

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

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

Запуск

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

npm run dev

Сборка

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

Так же выполняет проверку типов npm run type-check и статический анализ кода npm run lint

npm run build

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

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

npm run build-only

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

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

npm run type-check

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

npm run lint

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

Для генерации типов API используется пакет @openapitools/openapi-generator-cli

Для обновления типов API нужно убедиться, что в .env файле в поле GENERATE_API_SCHEMA_URL указан корректный URL JSON до файла openapi.json, который отдаёт Swagger

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

npm run generate-api

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

(папка src)

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

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

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

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

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

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

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

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

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

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