diff options
author | 2017-02-15 10:37:53 -0500 | |
---|---|---|
committer | 2017-02-15 10:40:37 -0500 | |
commit | 324ee36fe31763e507b422ab0a88e4230045e205 (patch) | |
tree | d0b04520f6657601c918ce63fd27575977624187 /dgbuilder/INSTALL.md | |
parent | f0c97e8db427481e28c0a16b789bc73801b35e47 (diff) |
Initial commit for OpenECOMP SDN-C OA&M
Change-Id: I7ab579fd0d206bf356f36d52dcdf4f71f1fa2680
Signed-off-by: Timoney, Daniel (dt5972) <dtimoney@att.com>
Former-commit-id: 2a9f0edd09581f907e62ec4689b5ac94dd5382ba
Diffstat (limited to 'dgbuilder/INSTALL.md')
-rw-r--r-- | dgbuilder/INSTALL.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/dgbuilder/INSTALL.md b/dgbuilder/INSTALL.md new file mode 100644 index 00000000..90922e6f --- /dev/null +++ b/dgbuilder/INSTALL.md @@ -0,0 +1,57 @@ +Node-RED Install +================ + +## Install node.js + +You can get the latest version from <http://nodejs.org/download/>. + +Or, you may want to use a version from your operating system's package manager: + <https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager> + +## Get Node-RED + +Clone the repository from GitHub: + + $ git clone git@github.com:node-red/node-red.git + +## Install the pre-requisite modules + +From the top-level directory of Node-RED, run: + + $ npm install + +This will install the core pre-requisite modules. + +## Run Node-RED + +From the top-level directory, run: + + $ node red.js + +You can then access Node-RED at <http://localhost:1880>. + +Online documentation is available at <http://nodered.org/docs>. + +## Installing individual node dependencies + +When Node-RED starts, it attempts to load the nodes from the `nodes/` directory. +Each will have its own set of dependencies that will need to be installed before +the node is available in the palette. + +To help identify the dependencies, Node-RED logs any modules it fails to find +for a particular node. You don't have to install these unless you want or need +that node to appear. + +Alternatively, a node's `.js` file can be examined to identify the modules it +explicitly requires. For example, the Twitter node is defined in +`nodes/social/27-twitter.js` and contains: + + var RED = require("../../red/red"); + var ntwitter = require('ntwitter'); + var OAuth= require('oauth').OAuth; + +Of these, `ntwitter` and `oauth` are neither built-in modules nor ones provided +by Node-RED itself. They can subsequently be installed by running: + + $ npm install ntwitter oauth + |