@vkontakte/create-vk-mini-app
Advanced tools
Пакет create-vk-mini-app предназначен для создания и развёртывания мини-приложений ВКонтакте. С его помощью вы можете быстро создать проект мини-приложения с подключёнными библиотеками и инструментами, которые необходимы для работы на платформе ВКонтакте.
Cборка с помощью Vite.
Автоматическое подключение и поддержка последних версий библиотек, необходимых для создания мини-приложений.
Конфигурация проекта под различные задачи.
Поддержка TypeScript и JavaScript.
Интерактивный режим создания проекта.
Бесплатный хостинг мини-приложения при помощи vk-miniapps-deploy.
yarn create @vkontakte/vk-mini-app [app-dir-name] [params]
npm init @vkontakte/vk-mini-app@latest [app-dir-name] -- [params]
Обратите внимание на двойное тире перед списком параметров. Оно необходимо, это требование npm.
npx @vkontakte/create-vk-mini-app [app-dir-name] [params]
Если вы используете более раннюю версию Node.js, чем 18.0.0, то вам нужен пакет create-vk-mini-app версии 1. Чтобы указать номер версии, введите @1 после названия пакета.
npx @vkontakte/create-vk-mini-app@1 [app-dir-name] [options]
Команды, упомянутые выше, запускают скрипт создания приложения. Скрипт последовательно попросит вас указать следующие параметры:
Имя папки для приложения. Если имя папки соответствует требованиям именования npm-пакетов, то это же имя будет указано как название проекта в package.json. Если имя папки не может быть использовано для именования пакета, скрипт попросит вас указать другое имя.
Язык программирования: TypeScript или JavaScript.
Структурные шаблоны — набор библиотек, которые будут включены в проект:
VKUI+Bridge+Router — рекомендуемый вариант для создания мини-приложений ВКонтакте.
VKUI+Bridge
VKUI-only — этот вариант не подходит для создания мини-приложений. Используйте его для быстрого создания веб-приложений, использующих библиотеку VKUI.
При запуске вы можете ввести следующие параметры командной строки, чтобы указать характеристики создаваемого приложения.
Все параметры необязательные.
| Параметр | Описание |
|---|---|
| app-dir-name | Имя папки для создаваемого приложения. |
| --projectName={name} | Имя проекта создаваемого приложения, которое будет указано в package.json.Используется в случае, когда имя папки не соответствует правилам именования npm-пакетов. |
| --typescript | Создаёт проект на TypeScript. Если этот параметр не указан, то скрипт попросит указать язык при создании приложения. |
| --template={name} или --t={name} | Структурный шаблон — набор библиотек, которые будут включены в приложение при создании. Возможные значения {name}:
|
yarn create @vkontakte/vk-mini-app mini-app --typescript --template=vkui-bridge-router
Создаст проект из структурного шаблона VKUI+Bridge+Router на TypeScript в подпапке mini-app текущей папки.
npm init @vkontakte/vk-mini-app . -- --template=vkapp-bridge-ui
Создаст проект из структурного шаблона VKUI+Bridge. Скрипт запросит имя папки и язык программирования.
| Параметр | Описание |
|---|---|
| vkui-bridge-router | Проект со следующими включёнными библиотеками:
В проект также подключены другие инструменты и пакеты, которые упрощают создание мини-приложений:
|
| vkui-bridge | Те же библиотеки и инструменты, что и при использовании vkui-bridge-router, за исключением библиотеки маршрутизации vk-mini-apps-router. |
| vkapp-only | Проект со следующими библиотеками и инструментами:
|
Сообщество VK Mini Apps — сообщество разработчиков мини-приложений ВКонтакте
Мы рады новым идеям и предложениям по улучшению библиотеки. Если вы хотите расширить примеры или улучшить интерфейс командной строки:
Сделайте ответвление (fork) репозитория.
Склонируйте репозиторий и установите зависимости, выполнив команду yarn.
Внесите изменения в код.
Выполните сборку с помощью команды yarn run build.
Установите изменённый пакет: yarn link.
Запустите его, чтобы протестировать изменения: create-vk-mini-app.
Отправьте MR нам на проверку.
v2.0.4
FAQs
VK Mini Apps Boilerplate
The npm package @vkontakte/create-vk-mini-app receives a total of 25 weekly downloads. As such, @vkontakte/create-vk-mini-app popularity was classified as not popular.
We found that @vkontakte/create-vk-mini-app demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.