@vkdev/vk-sandbox

1. 📦 Установите пакет: ```yarn add -D @vkdev/vk-sandbox``` 2. ✏️ Создайте или откройте файл ```vk-hosting-config.json``` и измените его, как показано ниже: ``` { "static_path": "build", "app_id": <ID вашего приложения>, ////////////////// Добавь это ////

Usage no npm install needed!

<script type="module">
  import vkdevVkSandbox from 'https://cdn.skypack.dev/@vkdev/vk-sandbox';
</script>

README

VK Sandbox

New way to test your apps 🔥

Как использовать?

  1. 📦 Установите пакет: yarn add -D @vkdev/vk-sandbox
  2. ✏️ Создайте или откройте файл vk-hosting-config.json и измените его, как показано ниже:
{
    "static_path": "build",
    "app_id": <ID вашего приложения>,
    ////////////////// Добавь это //////////////////
    "sandbox": {
        "url": "http://localhost:10888",
        "launch_params": {
            "access_token_settings": "",
            "are_notifications_enabled": 1,
            "is_app_user": 1,
            "is_favorite": 1,
            "language": "ru",
            "platform": "mobile_iphone",
            "ref": "other"
        }
    },
    ////////////////////////////////////////////
    "endpoints": {
        "mobile": "index.html",
        "mvk": "index.html",
        "web": "index.html"
    }
}
  1. ✏️ Создайте или откройте файлы .env и измените его, как показано ниже:
VK_SANDBOX_APP_SECRET_KEY=<секретный ключ вашего приложения>
VK_SANDBOX_APP_ACCESS_TOKEN=<сервисный токен вашего приложения>
  1. ❗️ ДОБАВЬТЕ .env В .gitignore
  2. ✏️ Добавьте скрипт в package.json:
    "scripts": {
        ...ваши другие скрипты...
        "sandbox": "vk-sandbox"
    },
  1. 🚀 Запустите ваш локальный тестовый сервер: yarn start
  2. 🔥 Запустите VK Sandbox: yarn sandbox

Настройки

Все настройки сандбокса находятся в файле vk-hosting-config.json в секции sandbox

Параметр Описание Значение по-умолчанию
url (required; string) Ссылка на бандл вашего приложения http://localhost:10888
launch_params (required; map of string) Параметры запуска, пишутся без префикса vk_ см. пример выше
disable_touch (optional; boolean) Отключение эмуляции серсерного экрана false

Поддерживаемые события

  • VKWebAppInit
  • VKWebAppUpdateConfig
  • VKWebAppGetClientVersion
  • VKWebAppOpenCodeReader
  • VKWebAppClose
  • VKWebAppEnableSwipeBack
  • VKWebAppDisableSwipeBack
  • VKWebAppCopyText
  • VKWebAppAllowNotifications
  • VKWebAppDenyNotifications
  • VKWebAppAddToFavorites
  • VKWebAppAddToHomeScreen
  • VKWebAppSendToClient
  • VKWebAppGetUserInfo
  • VKWebAppCallAPIMethod
  • VKWebAppGetAuthToken
  • VKWebAppStorageGet
  • VKWebAppStorageSet
  • VKWebAppStorageGetKeys
  • VKWebAppShowStoryBox
  • VKWebAppGetAds
  • VKWebAppShowNativeAds

Создатели

  • Степан Новожилов (@hit2hat)