@vkontakte/create-vk-mini-app

Create VK Mini App

Библиотека create-vk-mini-app — инструмент для быстрого создания и развертывания мини-приложений Вконтакте

Ключевые особенности

• Cборка на Vite.

• Интеграция с VKUI и vk-miniapps-router.

• Конфигурации шаблонов под различные задачи.

• Поддержка последних версий библиотек + typescript.

• Удобное интерактивное меню для настройки проекта.

• Бесплатный хостинг вашего приложения при помощи vk-mini-apps-deploy.

Установка и использование

yarn

yarn create @vkontakte/vk-mini-app [app-directory-name] [options]

npm

npm init @vkontakte/vk-mini-app@lastest [app-directory-name] [options]

npx

npx @vkontakte/create-vk-mini-app [app-directory-name] [options]

Для Node js < 18.0.0

Если вы используете Node js < 18.0.0 то вам нужен create-vk-mini-app v1.

npx @vkontakte/create-vk-mini-app@1 [app-directory-name] [options]

Опции

--typescript	Выбирает пример на typescript
--projectName	Выбирает имя, которое будет указано в package.json. Если параметр не передан, по умолчанию будет взято название директории
--t или --template	Выбирает структурный шаблон

Пример использования дополнительных опций

yarn create  @vkontakte/vk-mini-app mini-app --typescript --template=vkapp-router-bridge-ui

создаст папку “mini-app” c примером “vkapp-ui” реализованном на ts

yarn create  @vkontakte/vk-mini-app . --template=vkapp-bridge-ui

создаст пример “vkapp-bridge-ui” на js в текущей дериктории

Виды шаблонов

vkapp-router-bridge-ui	вариант мини-аппа со встроенным роутером, поддерживающим анимации vkui, подключенной библиотекой vk-bridge и интерфейсом vkui
vkapp-bridge-ui	вариант мини-аппа со встроенной библиотекой vk bridge и vkui интерфейсом
vkapp-ui	вариант веб приложения основанном на интерфейсе vkui, не является мини-аппом, так как в нем нет библиотеки vk bridge, отвечающей за связь с платформой

Полезные ссылки

• документация VKUI.

• документация vk-mini-apps-router.

• Примеры мини приложений.

• VK Mini Apps — сообщество разработчиков мини-приложений ВКонтакте.

Contributing

Мы очень радуемся, когда пользователи библиотеки работают над её улучшением. Если вы захотите расширить базу примеров или улучшить cli интерфейс, то:

1. Сделайте форк репозитория и склонируйте его.

2. Установите зависимости -yarn.

3. Внесите изменения.

4. Соберите - yarn run build.

5. Установите изменный пакет себе - yarn link.

6. И запустите, чтобы протестировать изменения - create-vk-mini-app.

7. Отправьте мр нам на проверку.