generator-botlerplate v3.1.0

Recast.AI - Generator Botlerplate

Recast.AI's official Generator Botlerplate in Node.js with Yeoman

Recast.AI's official Generator Botlerplate in Node.js with Yeoman

Synospis

This module is a generator that will help you easily start your project!

For more instructions on the Botlerplate, go to the Botlerplate

Installation

npm install -g generator-botlerplate

Usage

npm link
yo botlerplate

When asked for a project name:

Enter the name you want for your bot, example: myFirstSlackBot.

Then, choose if you prefer to use the sources of the botlerplate (with all source files directly available) or the module (with npm). Either way, you'll have something to start working on.

Select your preferences, and the Botlerplate will take care of the rest.

Next step is choosing if you need a mongoDB or not.

If you want a mongoDB, the required package will be installed. You just need to fill the config.js when all steps are completed. You can also install it after, no problems.

When asked for the connector you want to use, choose between:

• Slack
• Messenger
• Kik
• Microsoft Bot connector
• or just don't connect your bot.

This connector will automatically connect your bot to the chosen channel. You will directly have the server you need, so it's easier for you.

In this last step, decide if you want to have a code example with all the logic or not. The example given is a bot explaining you how to start with Recast.AI. You can always refer to our documentation for further information. The intents you'll need to launch this example bot are the ones from the bot you automatically have when registering on Recast.AI.

Press enter, and let the generator do the rest!

Everything you need is created in a folder with your project's name.

cd myFirstSlackBot/

You have a folder with your config.js, all your modules installed, your package.json, and src direcotry with a starter-pack of the channel you chose.

node_modules/
package.json
config.js
src
 |- actions
 |     |- booking.js
 |     |- greetings.js
 |     |- information.js
 |     |- no.js
 |     |- yes.js
 |
 |---- core
 |       |- action.js
 |       |- bot.js
 |       |- conversation.js
 |       |- emulator.js
 |
 |- server.js

Here it is!

You now have your own chatbot. Improve this code to make an even more amazing and custom bot!

Launch

Don't forget to improve your config.js file, and to start using it, use this command:

Run the server

npm start

Run the server for development (with live reload)

npm run server

Build all the sources from es6 to es5

npm run build

Test your bot locally in your terminal

npm run emulator

More

You can find more information about Recast.AI on man.recast.ai.

Author

Bruno Gantelmi (bruno.gantelmi@recast.ai) - Recast.AI

François Triquet (francois.triquet@recast.ai) - Recast.AI

You can follow us on Twitter at @recastai for updates and releases.

License

Copyright (c) 2016(https://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.