UNPKG

1.84 kBMarkdownView Raw
1# Node-RED
2
3http://nodered.org
4
5[![Build Status](https://travis-ci.org/node-red/node-red.svg)](https://travis-ci.org/node-red/node-red)
6[![Coverage Status](https://coveralls.io/repos/node-red/node-red/badge.svg?branch=master)](https://coveralls.io/r/node-red/node-red?branch=master)
7
8A visual tool for wiring the Internet of Things.
9
10![Node-RED: A visual tool for wiring the Internet of Things](http://nodered.org/images/node-red-screenshot.png)
11
12## Quick Start
13
14Check out http://nodered.org/docs/getting-started/ for full instructions on getting
15started.
16
171. `sudo npm install -g --unsafe-perm node-red`
182. `node-red`
193. Open <http://localhost:1880>
20
21## Getting Help
22
23More documentation can be found [here](http://nodered.org/docs).
24
25For further help, or general discussion, please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack).
26
27## Developers
28
29The main Node-RED modules are maintained as a monorepo on [GitHub](https://github.com/node-red/node-red).
30
31## Contributing
32
33Before raising a pull-request, please read our
34[contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
35
36This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/).
37 By participating, you are expected to uphold this code. Please report unacceptable
38 behavior to any of the project's core team at team@nodered.org.
39
40## Authors
41
42Node-RED is a project of the [JS Foundation](http://js.foundation).
43
44It was created by [IBM Emerging Technology](https://www.ibm.com/blogs/emerging-technology/).
45
46* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
47* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
48
49
50
51## Copyright and license
52
53Copyright JS Foundation and other contributors, http://js.foundation under [the Apache 2.0 license](LICENSE).