Skip to content

Быстрый старт ​

Создание проекта ​

Для старта проекта необходимо всего одна команда:

bash
npm create nsmp-embedded-app@latest

Интерактивные вопросы ​

CLI предложит:

  1. выбрать имя проекта;
  2. выбрать утилиты NSMP для добавления в src/utils/;
  3. подключить дополнительные пакеты;
  4. установить npm-зависимости.

Утилиты не добавляются в базовый проект автоматически. Выберите только нужные:

УтилитаДля чего нужна
environmentОпределение окружения Vite (development/production)
versionПроверка релизов GitHub или GitLab и сравнение версий
themeПолучение конфигурации темы NSMP; автоматически добавляет dispatch
dispatchРабота с GWT Dispatch и персональными настройками
platformОпределение платформы и правила возможностей интерфейса

Доступные дополнительные пакеты:

ПакетДля чего нужен
nsmp-iconsИконки для интерфейса NSMP
@iframe-resizer/childАвтоматическое изменение высоты embedded-приложения
@minitwiks/nsmp-vue-componentsГотовые Vue-компоненты и интеграция с Ant Design Vue

Выбранные пакеты и необходимая настройка автоматически добавляются в создаваемый проект.

Подключение к существующему проекту ​

CLI можно запустить из корня уже существующего проекта на Vue + Vite без имени нового приложения:

bash
npm create nsmp-embedded-app@latest

Если в package.json найдены пакеты vue и vite, CLI предложит выбрать NSMP-пакеты и утилиты. Он добавит пакеты в dependencies и скопирует выбранные утилиты в src/utils, но не создаст шаблон, не изменит исходный код приложения и не добавит ENV-файлы. Уже существующая папка утилиты будет пропущена без перезаписи.

Автоматические настройки пакетов, например импорт @iframe-resizer/child или регистрация @minitwiks/nsmp-vue-components, применяются только при создании нового проекта из шаблона. В существующем проекте подключите их вручную по документации соответствующего пакета.

Если автоматическая установка отключена, выполните её вручную:

bash
npm install

Первый запуск ​

Скопируйте пример окружения:

bash
cp example.env .env.development

Заполните параметры инсталляции, затем запустите dev-сервер:

bash
npm run dev

Первая сборка ​

bash
npm run build

Готовое приложение появится в dist/, а архив для NSMP — в dist-zip/.

Следующий шаг

Разберитесь, какие ENV-переменные нужны приложению, или сразу настройте публикацию в NSMP.