Botkit

Botkit is an open source developer tool for building chat bots, apps and cu...

Bot
howdyai/botkitbotkit

README

Botkit


Botkit is an open source developer tool for building chat bots, apps and custom integrations for major messaging platforms.

This repository contains the core Botkit library, as well as a series of plugins and extensions for connecting Botkit to messaging and chat platforms and other tools in the bot building ecosystem.

Botkit is part of the Microsoft Bot Framework
and is released under the MIT Open Source license

Use Botkit


Install Botkit and get started
Botkit Core Docs
Botkit Platform Support
Botkit Class Reference

Packages included in this repo


PackageDescriptionNPM
|---|---|---
[botkit](packages/botkit)Botkit[![NPM
[botbuilder-adapter-web](packages/botbuilder-adapter-web)A[![NPM
[botbuilder-adapter-slack](packages/botbuilder-adapter-slack)A[![NPM
[botbuilder-adapter-webex](packages/botbuilder-adapter-webex)A[![NPM
[botbuilder-adapter-hangouts](packages/botbuilder-adapter-hangouts)A[![NPM
[botbuilder-adapter-twilio-sms](packages/botbuilder-adapter-twilio-sms)A[![NPM
[botbuilder-adapter-facebook](packages/botbuilder-adapter-facebook)A[![NPM
[generator-botkit](packages/generator-botkit)A[![NPM
[botkit-plugin-cms](packages/botkit-plugin-cms)A[![NPM

Build Botkit locally


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:

  1. ```bash
  2. npm install -g typescript
  3. npm install -g lerna
  4. ```

Clone the entire Botkit project from Github.

  1. ```bash
  2. git clone git@github.com:howdyai/botkit.git
  3. ```

Enter the new folder and install the dependent packages:

  1. ```bash
  2. cd botkit
  3. npm install
  4. ```

Use lerna to set up the local packages:

  1. ```bash
  2. lerna bootstrap --hoist
  3. ```

Now, build all of the libraries:

  1. ```bash
  2. lerna run build
  3. ```

To build updated versions of the class reference documents found in packages/docs, run:

  1. ```bash
  2. lerna run build-docs
  3. ```