Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 3.29 KB

README.md

File metadata and controls

94 lines (59 loc) · 3.29 KB

You can talk with the bot on messenger!

Recast.AI starter kit NodeJS

A starter kit for developing bots on the Recast.AI platform.

Note: This project is currently in beta version and can be modified at any time.

Requirements

Node version

We recommend to use at least node v4.3.0

Usage

Installation

using npm npm install

or yarn yarn

Create the config file

Create a config.js file in the src directory of your project, copy/paste these lines:

module.exports = {
  MOVIEDB_TOKEN: '',
  REQUEST_TOKEN: '’,
};

Create your MovieDB account to get your token (https://developers.themoviedb.org/3)

Complete the Recast.AI REQUEST_TOKEN : go to your bot page, click on the settings icon (on the right side of your screen), and copy the request_token.

Tips: This config.js file will never be pushed onto your repository. If you would like to deploy your code with Bot Hosting, you just have to create env. variables in Bot Hosting section in RUN page. More info in About your config. file

Run locally

using npm npm start

using yarn yarn start

Note: Next steps, only if you have connected your bot to channels, using the Bot Connector tool

  • download ngrok
  • launch it: ./ngrok http 5000
  • copy the url ngrok gave and paste it in the Recast.AI interface: Go to your bot page, click on the RUN tab and edit your current bot webhook
  • Chat with your bot on the channels you've configured ;)

Documentation

Code Documentation
Receiving messages The Recast.AI SDK - connect
Sending messages The Recast.AI SDK - connect
Rich messaging See the different payload message
Manage the conversation The Recast.AI SDK - converse

More

You can view the whole API reference at man.recast.ai. You can follow us on Twitter at @recastai for updates and releases.

License

Copyright (c) [2017] Recast.AI

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.