Vott for Messenger (i.e. vott-messenger
) is a minimal, extensible framework for building Messenger bots.
Features
- Fully extensible conversational flow (middleware and plugins)
- Serves multiple pages from a single instance
- Scoped questions for complex conversational trees
- Thoroughly tested and secure
Simplicity First
In order to keep vott
as simple as possible, vott
makes no assumption on state-management, persistence layers, or message-processing functionality. Extra functionality must be provided by developers and third-party plugins or middleware.
Installation
$ npm install --save vott-messenger
Quick Example
const MessengerBot = /** instantiate MessengerBot */const myBot = access_token: processenvFB_PAGE_ACCESS_TOKEN verify_token: processenvFB_VERIFY_TOKEN endpoint: '/facebook/receive' /** usage example: */myBot myBot
Documentation
Guides
- Installing Vott for Messenger
- Getting Started
- Serving Multiple Pages
- Adding Persistence Layers
- Adding Middleware
- Adding Plugins
Reference
Contributing
Bug Reports & Feature Requests
Something does not work as expected or perhaps you think this module needs a feature? Please open an issue using GitHub's issue tracker. Please be as specific and straightforward as possible.
Developing
Pull Requests (PRs) are welcome. Make sure you follow the same basic stylistic conventions as the original code. Your changes must be concise and focus on solving a single problem.
Build Instructions for Contributors
Clone the repo:
$ git clone git@github.com:krismuniz/vott-messenger.git
Install all dependencies and run tests:
$ npm install && npm test
License
Copyright (c) 2017 Kristian Muñiz