@vkontakte/vk-tunnel

VK Tunnel

С помощью VK Tunnel вы можете сделать локальный веб-сервер доступным в интернете. Это нужно при отладке и демонстрации веб-приложений. VK Tunnel запускается на компьютере разработчика и создаёт специальное соединение (туннель), с помощью которого локальный веб-сервер становится доступным в интернете. Во время работы туннеля все внешние запросы к серверу и ответы на них проходят через туннель.

VK Tunnel предоставляет доступ к локальному серверу по протоколам HTTP, HTTPS, WebSocket и WebSocket Secure.

Установка

yarn

yarn global add @vkontakte/vk-tunnel

npm

npm install @vkontakte/vk-tunnel -g

Мы рекомендуем указать global для yarn или -g для npm, чтобы устанавливаемый пакет был доступен всем проектам на вашем компьютере.

Запуск, использование, параметры

Подробная информация об использовании и параметрах VK Tunnel — на портале для разработчиков ВКонтакте.

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

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

• Сообщество разработчиков мини-приложений ВКонтакте

• VK для разработчиков

Сотрудничество

Мы рады новым идеям и предложениям по улучшению библиотеки. Если вы хотите внести изменения:

1. Сделайте ответвление (fork) репозитория.

2. Склонируйте репозиторий и установите зависимости, выполнив команду yarn или npm install.

3. Внесите изменения в код.

4. Выполните сборку с помощью команды yarn run build или npm run build.

5. Установите изменённый пакет с помощью yarn link или npm link.

   Запустите его, чтобы протестировать изменения, выполнив vk-tunnel.

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

Changelog

v0.2.4

• Добавили поддержку бинарных WebSocket сообщений. Теперь сервер корректно обрабатывает и пересылает как текстовые, так и бинарные данные через WebSocket.
• Добавили возможность задавать ws-origin через через process.env.PROXY_WS_ORIGIN.