1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/README.md

71 lines
2.0 KiB
Markdown
Raw Normal View History

2013-09-05 16:02:48 +02:00
# Node-RED
http://nodered.org
[![Build Status](https://travis-ci.org/node-red/node-red.svg)](https://travis-ci.org/node-red/node-red)
[![Coverage Status](https://coveralls.io/repos/node-red/node-red/badge.svg?branch=master)](https://coveralls.io/r/node-red/node-red?branch=master)
2014-04-14 10:51:55 +02:00
2013-09-05 16:02:48 +02:00
A visual tool for wiring the Internet of Things.
2015-04-02 22:19:57 +02:00
![Node-RED: A visual tool for wiring the Internet of Things](http://nodered.org/images/node-red-screenshot.png)
2013-10-02 21:37:28 +02:00
2013-09-05 16:02:48 +02:00
## Quick Start
2015-04-02 22:19:57 +02:00
Check out http://nodered.org/docs/getting-started/ for full instructions on getting
started.
2013-09-05 16:02:48 +02:00
1. `sudo npm install -g --unsafe-perm node-red`
2015-04-02 22:19:57 +02:00
2. `node-red`
3. Open <http://localhost:1880>
2013-09-05 16:02:48 +02:00
2015-02-06 14:16:46 +01:00
## Getting Help
2013-09-26 22:12:31 +02:00
More documentation can be found [here](http://nodered.org/docs).
For further help, or general discussion, please use the [Node-RED Forum](https://discourse.nodered.org) or [slack team](https://nodered.org/slack).
2013-09-05 16:02:48 +02:00
2015-04-09 11:21:27 +02:00
## Developers
If you want to run the latest code from git, here's how to get started:
1. Clone the code:
2015-04-09 11:21:27 +02:00
git clone https://github.com/node-red/node-red.git
2015-04-09 11:21:27 +02:00
cd node-red
2. Install the node-red dependencies
2015-04-09 11:21:27 +02:00
npm install
3. Build the code
npm run build
2015-04-09 11:21:27 +02:00
4. Run
2015-04-09 11:21:27 +02:00
npm start
2015-04-09 11:21:27 +02:00
2013-09-05 16:02:48 +02:00
## Contributing
2015-04-02 22:19:57 +02:00
Before raising a pull-request, please read our
[contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
2013-09-05 21:39:33 +02:00
2016-04-07 22:13:40 +02:00
This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/).
2016-04-07 21:49:44 +02:00
By participating, you are expected to uphold this code. Please report unacceptable
2018-01-26 15:59:41 +01:00
behavior to any of the project's core team at team@nodered.org.
2016-04-07 21:49:44 +02:00
2013-09-05 16:02:48 +02:00
## Authors
Node-RED is a project of the [JS Foundation](http://js.foundation).
It was created by [IBM Emerging Technology](https://www.ibm.com/blogs/emerging-technology/).
2013-09-05 16:02:48 +02:00
2013-09-05 16:04:48 +02:00
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
2013-09-05 16:02:48 +02:00
2014-04-14 10:51:55 +02:00
2013-09-05 16:02:48 +02:00
## Copyright and license
Copyright JS Foundation and other contributors, http://js.foundation under [the Apache 2.0 license](LICENSE).