https://github.com/SamShakusky/vk-botlerplate

Minimalistic and easy to setup VK Bot boilerplate. Using node (express), parcel (es6 modules and async-await avaliable) and node-vk-bot-api.
https://github.com/SamShakusky/vk-botlerplate

async-await babel bot es6 express node node-vk-bot-api parcel vk

Last synced: 2 months ago
JSON representation

Minimalistic and easy to setup VK Bot boilerplate. Using node (express), parcel (es6 modules and async-await avaliable) and node-vk-bot-api.

• Host: GitHub
• URL: https://github.com/SamShakusky/vk-botlerplate
• Owner: SamShakusky
• License: mit
• Created: 2020-07-02T19:44:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T10:32:23.000Z (almost 2 years ago)
• Last Synced: 2024-07-29T16:59:22.045Z (5 months ago)
• Topics: async-await, babel, bot, es6, express, node, node-vk-bot-api, parcel, vk
• Language: JavaScript
• Homepage:
• Size: 1.53 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VK Bot Boilerplate (Botlerplate 🙃)

Minimalistic and easy to setup VK Bot boilerplate. Using node (express), parcel (es6 modules and async-await avaliable) and [node-vk-bot-api](/node-vk-bot-api/node-vk-bot-api).

Минималистичный и простой в настройке шаблон для ВК-бота. Включает в себя node (express), parcel (доступны es6 модули и async-await) и [node-vk-bot-api](/node-vk-bot-api/node-vk-bot-api).

## Быстрый старт

1.  Клонируйте репозиторий `git clone [email protected]:SamShakusky/vk-botlerplate.git `

2.  Перейдите в созданную директорию: `cd `.

3.  Установите зависимости `npm i`. Можно убедиться, что сервер запускается с помощью `npm run dev`, после чего открыть `http://localhost:3000`.

4. Залейте проект на хостинг (например, Heroku).

Всё готово к подключению к API ВК.

## Запуск бота

1.  Создайте сообщество в ВК.

2.  В управлении сообществом в разделе *Работа с API* сгенерируйте ключ доступа API. При этом необходимо выдать доступ к сообщениям.

3.  Во вкладке *Callback API* выберите последнюю версию API и укажите адрес вашего сервера. Во вкладке *Типы событий* отметьте *Входящие сообщения*.

    [Подробнее про Callback API](https://vk.com/dev/callback_api)

4.  В настройках вашего хостинга пропишите две env-переменные:

    **TOKEN** — это ключ доступа API вашего сообщества,

    **CONFIRMATION** — строка вида "5e4103e6", взятая с вкладки *Callback API* (строка, которую должен вернуть сервер).

5.  Перезапустите сервер, чтобы переменные стали доступны, и нажмите *Подтвердить* на вкладке *Callback API*.

Теперь все события, отмеченные во вкладке *Типы событий* будут приходить на ваш сервер. Осталось включить сообщения в настройках сообщества. После этого можно написать сообществу и получить ответ от бота.

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

* [Документация VK API](https://vk.com/dev/first_guide)

* [Документация node-vk-bot-api](/node-vk-bot-api/node-vk-bot-api)

## Дальнейшие шаги

1.  Поставьте звездочку этому репозиторию.

2.  Вы великолепны.

Лицензия

----

MIT