Create NSMP Embedded App

Интерактивный генератор embedded-приложений NSMP на Vue 3, TypeScript и Vite.

    _   _______ __  _______     ______          __             __    __         __   ___  by @minitwiks
   / | / / ___//  |/  / __ \   / ____/___ ___  / /_  ___  ____/ /___/ /__  ____/ /  /   |  ____  ____
  /  |/ /\__ \/ /|_/ / /_/ /  / __/ / __ '__ \/ __ \/ _ \/ __  / __  / _ \/ __  /  / /| | / __ \/ __ \
 / /|  /___/ / /  / / ____/  / /___/ / / / / / /_/ /  __/ /_/ / /_/ /  __/ /_/ /  / ___ |/ /_/ / /_/ /
/_/ |_//____/_/  /_/_/      /_____/_/ /_/ /_/_.___/\___/\__,_/\__,_/\___/\__,_/  /_/  |_/ .___/ .___/
                                                                                       /_/   /_/

Создайте новый NSMP Embedded App одной командой. CLI задаст необходимые вопросы прямо в терминале, скопирует готовый шаблон и при необходимости установит зависимости. Из корня существующего Vue + Vite проекта он предложит вместо этого подключить NSMP-пакеты и утилиты.

[!NOTE] Данный шаблон использует собственную ветку библиотеки js-api.

Возможности

• готовый шаблон на Vue 3, TypeScript и Vite;
• локальная разработка с проксированием запросов NSMP;
• типизированный mock-слой jsApi;
• автоматическая сборка ZIP-архива;
• публикация приложения через ENV-конфигурацию;
• ручные workflow для GitHub Actions и GitLab CI;
• выбор полезных утилит NSMP при создании или инициализации проекта;
• подключение дополнительных пакетов через интерактивный CLI.

CLI также умеет подключать эти зависимости и утилиты к уже существующему проекту на Vue + Vite. Запустите команду из корня такого проекта и подтвердите инициализацию: CLI обновит package.json и добавит выбранные папки в src/utils, не изменяя исходный код приложения.

npm create nsmp-embedded-app@latest

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

[!NOTE] Требования: Node.js 18+ и npm.

npm create nsmp-embedded-app@latest

Затем:

cd my-nsmp-app
cp example.env .env.development
npm run dev

Документация

Полное руководство по использованию шаблона, публикации в NSMP и доработке генератора находится в документации VitePress:

Для локального запуска документации:

npm install
npm run docs:dev

Разработка

npm install
npm --prefix template install
npm run check
npm test
npm run build
npm run docs:build

Лицензия

Проект распространяется под лицензией MIT.