This repository has been archived by the owner on Sep 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
readme.md
72 lines (51 loc) · 3.86 KB
/
readme.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# 
**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](https://dev.botframework.com)
and is released under the [MIT Open Source license](LICENSE.md)
# Use Botkit
* [Install Botkit and get started](packages/botkit#readme)
* [Botkit Core Docs](https://github.com/howdyai/botkit/blob/main/packages/docs/index.md)
* [Botkit Platform Support](https://github.com/howdyai/botkit/blob/main/packages/docs/platforms/index.md)
* [Botkit Class Reference](https://github.com/howdyai/botkit/blob/main/packages/docs/reference/index.md)
## Packages included in this repo
| Package | Description | NPM Status
|--- |--- |---
| [botkit](packages/botkit) | Botkit Core library | [](https://www.npmjs.com/package/botkit/)
| [botbuilder-adapter-web](packages/botbuilder-adapter-web) | A platform adapter for the web | [](https://www.npmjs.com/package/botbuilder-adapter-web)
| [botbuilder-adapter-slack](packages/botbuilder-adapter-slack) | A platform adapter for Slack | [](https://www.npmjs.com/package/botbuilder-adapter-slack)
| [botbuilder-adapter-webex](packages/botbuilder-adapter-webex) | A platform adapter for Webex Teams | [](https://www.npmjs.com/package/botbuilder-adapter-webex)
| [botbuilder-adapter-hangouts](packages/botbuilder-adapter-hangouts) | A platform adapter for Google | [](https://www.npmjs.com/package/botbuilder-adapter-hangouts)
| [botbuilder-adapter-twilio-sms](packages/botbuilder-adapter-twilio-sms) | A platform adapter for Twilio SMS | [](https://www.npmjs.com/package/botbuilder-adapter-twilio-sms)
| [botbuilder-adapter-facebook](packages/botbuilder-adapter-facebook) | A platform adapter for Facebook Messenger | [](https://www.npmjs.com/package/botbuilder-adapter-facebook)
| [generator-botkit](packages/generator-botkit) | A Yeoman generator for creating a new Botkit project | [](https://www.npmjs.com/package/generator-botkit)
| [botkit-plugin-cms](packages/botkit-plugin-cms) | A plugin that adds support for [Botkit CMS](https://github.com/howdyai/botkit-cms) | [](https://www.npmjs.com/package/botkit-plugin-cms)
## 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](https://github.com/lerna/lerna) and [TypeScript](https://www.typescriptlang.org/) globally:
```bash
npm install -g typescript
npm install -g lerna
```
Clone the entire Botkit project from Github.
```bash
git clone git@github.com:howdyai/botkit.git
```
Enter the new folder and install the dependent packages:
```bash
cd botkit
npm install
```
Use lerna to set up the local packages:
```bash
lerna bootstrap --hoist
```
Now, build all of the libraries:
```bash
lerna run build
```
To build updated versions of the class reference documents found in `packages/docs`, run:
```bash
lerna run build-docs
```