# 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 — на [портале для разработчиков ВКонтакте](https://dev.vk.ru/libraries/tunnel).

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

- [Примеры мини-приложений](https://dev.vk.ru/mini-apps/examples)

- [Сообщество разработчиков мини-приложений ВКонтакте](https://vk.ru/vkappsdev)

- [VK для разработчиков](https://dev.vk.ru)

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

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

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

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

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

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

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

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

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