https://github.com/vkcom/vk-tunnel-client
https://github.com/vkcom/vk-tunnel-client
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vkcom/vk-tunnel-client
- Owner: VKCOM
- Created: 2020-08-12T13:44:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-14T06:57:07.000Z (over 1 year ago)
- Last Synced: 2024-10-29T15:50:57.645Z (over 1 year ago)
- Language: TypeScript
- Size: 379 KB
- Stars: 23
- Watchers: 12
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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.com/libraries/tunnel).
## Полезные ссылки
- [Примеры мини-приложений](https://dev.vk.com/mini-apps/examples)
- [Сообщество разработчиков мини-приложений ВКонтакте](https://vk.com/vkappsdev)
- [VK для разработчиков](https://dev.vk.com)
## Сотрудничество
Мы рады новым идеям и предложениям по улучшению библиотеки. Если вы хотите внести изменения:
1. Сделайте ответвление (fork) репозитория.
2. Склонируйте репозиторий и установите зависимости, выполнив команду `yarn` или `npm install`.
3. Внесите изменения в код.
4. Выполните сборку с помощью команды `yarn run build` или `npm run build`.
5. Установите изменённый пакет с помощью `yarn link` или `npm link`.
Запустите его, чтобы протестировать изменения, выполнив `vk-tunnel`.
6. Отправьте MR нам на проверку.