This branch is home to the next major release of Botkit, which is based on a complete rewrite of the library.
This is a not a finished product! We are publishing it now as a preview so our community of developers, users and contributors can get involved. Some features are missing or not working, and some features currently included may be removed.
View the roadmap planning board for this release
GOALS:
- Keep as much of the feature set, syntax and special sauce developers know and love
- Solve persistent and hard to solve problems in previous versions of Botkit
- Use modern JavaScript language features like async/await instead of callbacks
- Full Typescript support
- Break platform adapters (and their large dependency trees) into optional packages
- Reorganize some related projects into a monorepo
- Inherit much goodness from Bot Builder
- Provide a way for bots to be extended with plugins and modular features, and for those plugins to provide a consistent interface to administrators
- Install Botkit and get started
- Botkit Core Docs
- Botkit for the Web
- Botkit for Slack
- Botkit for Webex Teams
- Botkit for Google Hangouts
- Botkit for Twilio SMS
- Botkit for Facebook Messenger
Package | Description |
---|---|
botkit | Botkit Core library |
botbuilder-adapter-websocket | A platform adapter for the web |
botbuilder-adapter-slack | A platform adapter for Slack |
botbuilder-adapter-webex | A platform adapter for Webex Teams |
botbuilder-adapter-hangouts | A platform adapter for Google Hangouts |
botbuilder-adapter-twilio-sms | A platform adapter for Twilio SMS |
botbuilder-adapter-facebook | A platform adapter for Facebook Messenger |
generator-botkit | A Yeoman generator for creating a new Botkit project |
botbuilder-dialogs-botkit-cms | A library that allows using Botkit CMS content in Bot Builder apps (without Botkit) |
This repo contains multiple inter-linked packages containing Botkit Core, platform adapter packages, and some additional plugins and extensions. To build these locally, follow the instructions below.
Install lerna and TypeScript globally:
npm install -g typescript
npm install -g lerna
Clone the entire Botkit project from Github.
git clone git@github.com:howdyai/botkit.git
Enter the new folder, and switch to the next
branch.
cd botkit
git checkout next
npm install
Use lerna to set up the local packages:
lerna bootstrap --hoist
Now, build all of the libraries:
lerna run build
To build updated versions of the class reference documents found in packages/docs
, run:
lerna run build-docs