botkit README

The project's README from github.com/howdyai/botkit. As one markdown file: README.md.

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

Packages included in this repo

Package Description NPM Status
botkit Botkit Core library NPM Badge
botbuilder-adapter-web A platform adapter for the web NPM Badge
botbuilder-adapter-slack A platform adapter for Slack NPM Badge
botbuilder-adapter-webex A platform adapter for Webex Teams NPM Badge
botbuilder-adapter-hangouts A platform adapter for Google NPM Badge
botbuilder-adapter-twilio-sms A platform adapter for Twilio SMS NPM Badge
botbuilder-adapter-facebook A platform adapter for Facebook Messenger NPM Badge
generator-botkit A Yeoman generator for creating a new Botkit project NPM Badge
botkit-plugin-cms A plugin that adds support for Botkit CMS NPM Badge

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:

npm install -g typescript
npm install -g lerna

Clone the entire Botkit project from Github.

git clone [email protected]:howdyai/botkit.git

Enter the new folder and install the dependent packages:

cd botkit
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

botkit (howdyai/botkit)

Searching Database…

11.6K ·GitHub
archived
What is this?Botkit is an open source developer tool for building chat bots, apps, and custom integrations for major messaging platforms like Slack, Facebook Messenger, Twilio SMS, Webex Teams, and Google Hangouts.
Is this a standalone app or a framework I build on top of?It is a framework/library: a core 'botkit' package plus separate platform-adapter packages (Slack, Webex, Facebook, Twilio SMS, web, Google Hangouts) that you install into your own Node.js project. It's also part of the Microsoft Bot Framework.
How do I get started building a bot with it?Follow the 'Install Botkit and get started' guide, or if building from source: clone the monorepo, install lerna and TypeScript globally, run npm install, then 'lerna bootstrap' and 'lerna run build' to compile all packages.
What do I need installed before building this from source?You need Node.js/npm, plus lerna and TypeScript installed globally, since this is a lerna-managed monorepo of TypeScript packages.
Is this project still maintained?No — the repository is archived on GitHub, meaning it no longer receives active updates or support.
Which messaging platforms have official adapters?The repo ships adapters for web, Slack, Webex Teams (formerly Cisco Spark), Google Hangouts, Twilio SMS, and Facebook Messenger, each as its own npm package.
What is generator-botkit?It's a Yeoman generator included in the repo for scaffolding a new Botkit project quickly.
What does botkit-plugin-cms do?It's a plugin that connects a Botkit bot to Botkit CMS for managing conversation content outside of code.
Can I still use this for a new bot project today?You can, since it's MIT-licensed and the code is public, but since the repo is archived you won't get bug fixes or new platform support going forward.
What are similar projects?rasa, wechaty, botpress, novu, Telethon, chatwoot, hubot, ParlAI
Creator
howdyai
Size
11.8 MB
Stars
11.6K
Age
10y
Commits · 90 Days