Быстрый старт
Создание проекта
Для старта проекта необходимо всего одна команда:
npm create nsmp-embedded-app@latestИнтерактивные вопросы
CLI предложит:
- выбрать имя проекта;
- выбрать утилиты NSMP для добавления в
src/utils/; - подключить дополнительные пакеты;
- установить 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 без имени нового приложения:
npm create nsmp-embedded-app@latestЕсли в package.json найдены пакеты vue и vite, CLI предложит выбрать NSMP-пакеты и утилиты. Он добавит пакеты в dependencies и скопирует выбранные утилиты в src/utils, но не создаст шаблон, не изменит исходный код приложения и не добавит ENV-файлы. Уже существующая папка утилиты будет пропущена без перезаписи.
Автоматические настройки пакетов, например импорт @iframe-resizer/child или регистрация @minitwiks/nsmp-vue-components, применяются только при создании нового проекта из шаблона. В существующем проекте подключите их вручную по документации соответствующего пакета.
Если автоматическая установка отключена, выполните её вручную:
npm installПервый запуск
Скопируйте пример окружения:
cp example.env .env.developmentЗаполните параметры инсталляции, затем запустите dev-сервер:
npm run devПервая сборка
npm run buildГотовое приложение появится в dist/, а архив для NSMP — в dist-zip/.
Следующий шаг
Разберитесь, какие ENV-переменные нужны приложению, или сразу настройте публикацию в NSMP.