├── .gitignore ├── LICENSE ├── README.md ├── package.json └── settings.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 18 | .grunt 19 | 20 | # node-waf configuration 21 | .lock-wscript 22 | 23 | # Compiled binary addons (http://nodejs.org/api/addons.html) 24 | build/Release 25 | 26 | # Dependency directory 27 | node_modules 28 | 29 | # Optional npm cache directory 30 | .npm 31 | 32 | # Optional REPL history 33 | .node_repl_history 34 | 35 | # OSX 36 | .DS_Store 37 | 38 | # Node-RED 39 | .config.json 40 | .sessions.json 41 | *json.backup 42 | *_cred.json 43 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # node-red-project-template 2 | This is a template for a Node-RED project meant to be run in local mode. The idea is to run an instance of Node-RED entirely from within a local directory to make it more portable. This also makes running multiple instances of Node-RED at the same time easier. 3 | 4 | Node-RED will start with a blank canvas and will save the flow file to flows.json the first time a deploy is done. If you add your own flows.json file it will load that by default. 5 | 6 | ## Usage 7 | 8 | ``` 9 | mkdir MyNiceProject 10 | cd MyNiceProject 11 | git clone https://github.com/natcl/node-red-project-template.git . 12 | npm install 13 | npm start 14 | ``` 15 | 16 | When running multiple instances in parallel, you can specify a port: 17 | 18 | ``` 19 | npm start -- -p 1885 20 | ``` 21 | To run a specific flow file: 22 | 23 | ``` 24 | npm start -- testFlow.json 25 | ``` 26 | 27 | ## Dependencies 28 | 29 | You can easily add third party nodes by modifying the package.json file. For this template we added the node-red-contrib-ui package. 30 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name" : "node-red-project-template", 3 | "version" : "0.0.1", 4 | "description" : "Node-RED project template", 5 | "license" : "Apache-2.0", 6 | "dependencies": { 7 | "node-red": "~0.17.5", 8 | "node-red-dashboard": "~2.7.0." 9 | }, 10 | "scripts": { 11 | "start": "node node_modules/node-red/red.js -v -u ." 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "https://github.com/natcl/node-red-project-template.git" 16 | }, 17 | "keywords": [ "node-red" ] 18 | } 19 | -------------------------------------------------------------------------------- /settings.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2013, 2015 IBM Corp. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | **/ 16 | 17 | // The `https` setting requires the `fs` module. Uncomment the following 18 | // to make it available: 19 | //var fs = require("fs"); 20 | 21 | module.exports = { 22 | // the tcp port that the Node-RED web server is listening on 23 | uiPort: 1880, 24 | 25 | // By default, the Node-RED UI accepts connections on all IPv4 interfaces. 26 | // The following property can be used to listen on a specific interface. For 27 | // example, the following would only allow connections from the local machine. 28 | //uiHost: "127.0.0.1", 29 | 30 | // Retry time in milliseconds for MQTT connections 31 | mqttReconnectTime: 15000, 32 | 33 | // Retry time in milliseconds for Serial port connections 34 | serialReconnectTime: 15000, 35 | 36 | // Retry time in milliseconds for TCP socket connections 37 | //socketReconnectTime: 10000, 38 | 39 | // Timeout in milliseconds for TCP server socket connections 40 | // defaults to no timeout 41 | //socketTimeout: 120000, 42 | 43 | // The maximum length, in characters, of any message sent to the debug sidebar tab 44 | debugMaxLength: 1000, 45 | 46 | // The file containing the flows. If not set, it defaults to flows_.json 47 | flowFile: 'flows.json', 48 | 49 | // To enabled pretty-printing of the flow within the flow file, set the following 50 | // property to true: 51 | flowFilePretty: true, 52 | 53 | // By default, all user data is stored in the Node-RED install directory. To 54 | // use a different location, the following property can be used 55 | //userDir: '/home/nol/.node-red/', 56 | 57 | // Node-RED scans the `nodes` directory in the install directory to find nodes. 58 | // The following property can be used to specify an additional directory to scan. 59 | //nodesDir: '/home/nol/.node-red/nodes', 60 | 61 | // By default, the Node-RED UI is available at http://localhost:1880/ 62 | // The following property can be used to specifiy a different root path. 63 | // If set to false, this is disabled. 64 | //httpAdminRoot: '/admin', 65 | 66 | // Some nodes, such as HTTP In, can be used to listen for incoming http requests. 67 | // By default, these are served relative to '/'. The following property 68 | // can be used to specifiy a different root path. If set to false, this is 69 | // disabled. 70 | //httpNodeRoot: '/red-nodes', 71 | 72 | // The following property can be used in place of 'httpAdminRoot' and 'httpNodeRoot', 73 | // to apply the same root to both parts. 74 | //httpRoot: '/red', 75 | 76 | // When httpAdminRoot is used to move the UI to a different root path, the 77 | // following property can be used to identify a directory of static content 78 | // that should be served at http://localhost:1880/. 79 | //httpStatic: './static', 80 | 81 | // Securing Node-RED 82 | // ----------------- 83 | // To password protect the Node-RED editor and admin API, the following 84 | // property can be used. See http://nodered.org/docs/security.html for details. 85 | // adminAuth: { 86 | // type: "credentials", 87 | // users: [{ 88 | // username: "admin", 89 | // password: "$2a$08$xzwYcCsmEBVsdr82DQXewxsdfd1uhuxR6vOXl2ah2hgvnmlypqi", 90 | // permissions: "*" 91 | // }] 92 | // }, 93 | 94 | // To password protect the node-defined HTTP endpoints (httpNodeRoot), or 95 | // the static content (httpStatic), the following properties can be used. 96 | // The pass field is a bcrypt hash of the password. 97 | // See http://nodered.org/docs/security.html#generating-the-password-hash 98 | //httpNodeAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, 99 | //httpStaticAuth: {user:"user",pass:"$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN."}, 100 | 101 | // The following property can be used to enable HTTPS 102 | // See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener 103 | // for details on its contents. 104 | // See the comment at the top of this file on how to load the `fs` module used by 105 | // this setting. 106 | // 107 | //https: { 108 | // key: fs.readFileSync('privatekey.pem'), 109 | // cert: fs.readFileSync('certificate.pem') 110 | //}, 111 | 112 | // The following property can be used to disable the editor. The admin API 113 | // is not affected by this option. To disable both the editor and the admin 114 | // API, use either the httpRoot or httpAdminRoot properties 115 | //disableEditor: false, 116 | 117 | // The following property can be used to configure cross-origin resource sharing 118 | // in the HTTP nodes. 119 | // See https://github.com/troygoode/node-cors#configuration-options for 120 | // details on its contents. The following is a basic permissive set of options: 121 | //httpNodeCors: { 122 | // origin: "*", 123 | // methods: "GET,PUT,POST,DELETE" 124 | //}, 125 | 126 | // If you need to set an http proxy please set an environment variable 127 | // called http_proxy (or HTTP_PROXY) outside of Node-RED in the operating system. 128 | // For example - http_proxy=http://myproxy.com:8080 129 | // (Setting it here will have no effect) 130 | // You may also specify no_proxy (or NO_PROXY) to supply a comma separated 131 | // list of domains to not proxy, eg - no_proxy=.acme.co,.acme.co.uk 132 | 133 | // The following property can be used to add a custom middleware function 134 | // in front of all http in nodes. This allows custom authentication to be 135 | // applied to all http in nodes, or any other sort of common request processing. 136 | //httpNodeMiddleware: function(req,res,next) { 137 | // // Handle/reject the request, or pass it on to the http in node 138 | // // by calling next(); 139 | // next(); 140 | //}, 141 | 142 | // Anything in this hash is globally available to all functions. 143 | // It is accessed as context.global. 144 | // eg: 145 | // functionGlobalContext: { os:require('os') } 146 | // can be accessed in a function block as: 147 | // context.global.os 148 | 149 | functionGlobalContext: { 150 | // moment:require('moment') 151 | // os:require('os'), 152 | // octalbonescript:require('octalbonescript'), 153 | // jfive:require("johnny-five"), 154 | // j5board:require("johnny-five").Board({repl:false}) 155 | }, 156 | 157 | // The following property can be used to order the categories in the editor 158 | // palette. If a node's category is not in the list, the category will get 159 | // added to the end of the palette. 160 | // If not set, the following default order is used: 161 | //paletteCategories: ['subflows', 'input', 'output', 'function', 'social', 'mobile', 'storage', 'analysis', 'advanced'], 162 | 163 | // Configure the logging output 164 | logging: { 165 | // Only console logging is currently supported 166 | console: { 167 | // Level of logging to be recorded. Options are: 168 | // fatal - only those errors which make the application unusable should be recorded 169 | // error - record errors which are deemed fatal for a particular request + fatal errors 170 | // warn - record problems which are non fatal + errors + fatal errors 171 | // info - record information about the general running of the application + warn + error + fatal errors 172 | // debug - record information which is more verbose than info + info + warn + error + fatal errors 173 | // trace - record very detailed logging + debug + info + warn + error + fatal errors 174 | level: "info", 175 | 176 | // Whether or not to include metric events in the log output 177 | metrics: false, 178 | // Whether or not to include audit events in the log output 179 | audit: false 180 | } 181 | } 182 | } 183 | --------------------------------------------------------------------------------