Welcome to the Alcatel-Lucent Enterprise Starter-Kit Rainbow SDK for Node.JS with Watson!
The Alcatel-Lucent Enterprise (ALE) Starter-Kit Rainbow SDK for Node.JS Watson is a basic sample for starting your development using the SDK for Node.JS and Watson in an easy way and within an advanced environment.
You need a Node.JS LTS release installed on your computer.
You need a Rainbow account. Connect to the Rainbow HUB to get your developer account.
Clone this repository in the directory you want and then open a shell and executes the following command
$ npm install
This Starter-Kit is a Node.JS application that:
-
Starts the SDK for Node.JS, connects it to Rainbow and answers to incoming chat messages by using Watson to understand natural language
-
Starts a web server for monitoring your application
Note: You have to teach Watson on the natural language you want that the bot understands.
In order to setup your application, you have to configure 4 JSON files:
-
app/config/bot.json: This file contains the parameters for the SDK for Node.JS. Modify it with your Rainbow account. -
app/config/router.json: This file contains the default parameter for the embedded web server. Modify it according to your needs. -
app/config/watson.json: This file contains the parameters for Watson. Modify it with your Watson account. -
app/modules/watson.js: This file contains the watson login. Adapt it depending on your needs.
Once you have configured these two files, you can start the application by launching the following command:
$ node index.js
Your Node.JS contains an embedded server with 3 default routes:
-
GET .../health/ping: API for having an health check of your application -
POST .../health/sdk/restart: API for restarting the SDK for Node.JS (stop and start). -
GET .../health/sdk/status: API for having a status of the SDK for Node.JS
You can test these routes using CURL. Here is an example of testing the health/ping route when the Web Server is launched using HTTP and port 3002:
$ curl -X GET http://localhost:3002/health/ping
> {"code":0}
Note: When testing in HTTPS, default self-signed certificates are proposed. For testing with CURL, you have to add the parameter -k to avoid the CURL's verification like as follows (launched with HTTPS and port 3003):
$ curl -X GET https://localhost:3003/health/ping -k
> {"code":0}
Basic rules for Node.JS JavaScript development have been added.
Tests have to be added in directory test.
to launch the test, open a shell and execute the following command:
$ npm test
Each time a file is modified, the tests are executed.
If you want to check the code coverage, launch the following command:
$ npm run coverage
New modules can be added to your application in directory app.
Thanks to Dockerfile available a root directory, you are able to run the current Starter Kit into Docker.
After Docker installation ( See Docker ), run the following command to build your own image.
docker build -t rainbow-api-hub/startkit-sdk-nodejs .
3 environment variables are required to run a container instance with the previous builded image:
-
RAINBOW_BOT_LOGIN(mandatory): User email associated to your bot. -
RAINBOW_BOT_PASSWORD(mandatory): User password associated to your bot. -
RAINBOW_BOT_APPID(mandatory): Application ID associated to your bot. -
RAINBOW_BOT_APPSECRET(mandatory): Application Secret associated to your bot. -
RAINBOW_HOST(optional, default value: sandbox.openrainbow.com ): Target host where your want to run your bot.
you have also to take into account the IBM Watson Assistant settings, please take a look in Assistant V2 documentation, for more information.
Use the following command in order to start you container instance, with the port 8888 as REST api entry point port
docker run -p 8888:8080 -e RAINBOW_BOT_LOGIN=<BOT_EMAIL> -e RAINBOW_BOT_PASSWORD=<BOT_PWD> ... -t rainbow-api-hub/startkit-sdk-nodejs
Thank you the manifest.yml file, you are able to deploy the project into cloudfoundry infrastructure like IBM Bluemix.