| 1 | # Recime Bot Runtime
|
| 2 |
|
| 3 | This runtime is intended to run inside a micro-service container with platform specific integration and module interpreter.
|
| 4 |
|
| 5 | The runtime is used to run chatbots intended for Facebook, Telerik, Slack, Viber, and Wechat. It provides developers the platform specific integration and OAuth integration (e.g. Slack).
|
| 6 |
|
| 7 | # Setup
|
| 8 |
|
| 9 | Create a `.env` file in the root directory with the following properties:
|
| 10 |
|
| 11 | ```
|
| 12 |
|
| 13 | BOT_UNIQUE_ID=awesome-bot
|
| 14 | HOME_DIR=main-folder
|
| 15 |
|
| 16 | ```
|
| 17 |
|
| 18 | Clone the [recime-bot-es6-template](https://github.com/Recime/recime-bot-es6-template) under `main-folder` and rename it to `awesome-bot`.
|
| 19 |
|
| 20 |
|
| 21 | # Configure
|
| 22 |
|
| 23 | Configure the platform you want to run the bot on. Add the following variables to you `.env` file:
|
| 24 |
|
| 25 | ## Facebook
|
| 26 |
|
| 27 | ```
|
| 28 |
|
| 29 | RECIME_FACEBOOK_ACCESS_TOKEN=PASTE_YOUR_PAGE_ACCESS_TOKEN
|
| 30 | RECIME_FACEBOOK_APP_ID=PASTE_YOUR_APP_ID
|
| 31 | RECIME_FACEBOOK_APP_SECRET=PASTE_YOUR_APP_SECRET
|
| 32 |
|
| 33 | ```
|
| 34 |
|
| 35 | ## Telergram
|
| 36 |
|
| 37 | ```
|
| 38 | RECIME_TELEGRAM_ACCESS_TOKEN=PASTE_YOUR_TELEGRAM_ACCESS_TOKEN
|
| 39 | ```
|
| 40 |
|
| 41 | ## Viber
|
| 42 |
|
| 43 | ```
|
| 44 | RECIME_VIBER_ACCESS_TOKEN=PASTE_YOUR_VIBER_ACCESS_TOKEN
|
| 45 | ```
|
| 46 |
|
| 47 | # Run
|
| 48 |
|
| 49 | Type the following command in your terminal:
|
| 50 |
|
| 51 | ```
|
| 52 | npm start
|
| 53 |
|
| 54 | ```
|
| 55 |
|
| 56 | This is will configure prepare the bot, configure the platform. Go to your bot and start chatting with it.
|
| 57 |
|
| 58 |
|
| 59 |
|
| 60 | # License
|
| 61 |
|
| 62 | Copyright © 2017 Recime Inc. All rights reserved. |
| \ | No newline at end of file |