node-red-contrib-circuit

node-red-contrib-circuit

This node-red-contrib-circuit is simple Node-Red git ui that allows you to easily integrate the functionality of the circuit sdk into your applications using node-red.

Pre-requisites

Requires Node-Red version 0.18.7 or more recent.
Requires a https://circuitsandbox.net account with a bot to host the application with OAuth client_credentials.

Installations

Make sure you have NodeRed installed on your machine, if not you can install it by running the below command.
$ npm install -g --unsafe-perm node-red
Then you can start node-red by typing node-red in the command lind. More information on node-red can be found
at the node-red github here.

Installing node-red-contrib-circuit

Either install via pallette or via "npm install".
$ npm install node-red-contrib-circuit
Run the following command for global install.
$ npm install -g node-red-contrib-circuit

Getting started

• Install both node-red and node-red-contrib-circuit as displayed above.
• Once both packages are installed you will need a bot with OAuth client_credentials to run your application with.
  You can go here and follow the instructions to obtain your credentials.
• Start node-red by typing $ node-red into the command line and wait for the server to be loaded. After node-red is running you should be able to go to localhost:1880 to view your node-red server. If the node-red-contrib-circuit has been installed properly you should be able to scroll through your nodes and view the available API nodes to use.
• Once everything else is working you can follow the instructions in the Usage section.

Usage

• Select node with API functionality you desire.
• Enter the circuit-server information needed for bot, such as: client_id, client_secret, domain.
• Additional information on circuit client can be found at: https://github.com/circuit/circuit-sdk.

Applications

You can easily make applications using node-red and integrate them with our node-red-contrib-circuit API nodes. If you go here you can find an example flow that creates a bot to listen to a conversation and will send requests to look up weather, define words, and tell you jokes.

Testing

Under development...