frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
Code Issues Releases Wiki Activity
145 Commits 119 Branches 156 Tags 55 MiB
JavaScript 99.7%
HTML 0.3%
f3040ae95c
Go to file
Dave C-J f3040ae95c Add warning to Arduino node (as underlying firmata won't allow pins to be both inputas and outputs at the same time)
2013-10-16 19:10:34 +01:00
lib Add lib .gitignore 2013-09-05 15:07:01 +01:00
nodes Add warning to Arduino node (as underlying firmata won't allow pins to be both inputas and outputs at the same time) 2013-10-16 19:10:34 +01:00
public Add switch node 2013-10-13 20:28:21 +01:00
red Allow icons to be bundled with nodes 2013-10-13 21:01:46 +01:00
.gitignore Got to start somewhere 2013-09-05 15:02:48 +01:00
.nodemonignore Got to start somewhere 2013-09-05 15:02:48 +01:00
INSTALL.md Update docs 2013-09-26 21:12:31 +01:00
LICENSE Got to start somewhere 2013-09-05 15:02:48 +01:00
package.json Fix main property of package.json 2013-09-26 19:58:42 +01:00
README.md Add mailing list links to README 2013-10-04 21:44:00 +01:00
red.js Bit more of a shuffle round of the shutdown handling 2013-10-13 19:14:39 +01:00
settings.js Fix camel case of flowFile in settings.js 2013-10-05 21:21:51 +01:00

README.md

Node-RED

A visual tool for wiring the Internet of Things.

Screenshot

Quick Start

Check out INSTALL for full instructions on getting started.

  1. download the zip and unzip, or git clone
  2. cd node-red
  3. npm install
  4. node red.js
  5. Open http://localhost:1880

Documentation

More documentation can be found here.

For further help, or general discussion, there is also a mailing list.

Browser Support

The Node-RED editor runs in the browser. We routinely develop and test using Chrome and Firefox. We have anecdotal evidence that it works in IE9.

We do not yet support mobile browsers, although that is high on our priority list.

Contributing

Reporting issues

Please raise any bug reports on the project's issue tracker. Be sure to search the list to see if your issue has already been raised.

For feature requests, please raise them on the mailing list first.

Creating new nodes

The plugin nature of Node-RED means anyone can create a new node to extend its capabilities.

We want to avoid duplication as that can lead to confusion. Many of our existing nodes offer a starting point of functionality. If they are missing features, we would rather extend them than add separate 'advanced' versions. But the key to that approach is getting the UX right to not lose the simplicity.

We are also going to be quite selective over what nodes are included in the main repository - enough to be useful, but not so many that new user is overwhelmed.

To contribute a new node, please raise a pull-request against the node-red-nodes repository.

Eventually, the nodes will be npm-installable, but we're not there yet. We'll also have some sort of registry of nodes to help with discoverability.

Pull-Requests

In order for us to accept pull-requests, the contributor must first complete a Contributor License Agreement (CLA). This clarifies the intellectual property license granted with any contribution. It is for your protection as a Contributor as well as the protection of IBM and its customers; it does not change your rights to use your own Contributions for any other purpose.

Once you have created a pull-request, we'll provide a link to the appropriate CLA document.

If you are an IBMer, please contact us directly as the contribution process is slightly different.

Authors

Node-RED is a creation of the IBM Emerging Technology Services team.

Copyright and license

Copyright 2013 IBM Corp. under the Apache 2.0 license.