node-red/README.md

74 lines
2.0 KiB
Markdown
Raw Normal View History

2013-09-05 14:02:48 +00: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 08:51:55 +00:00
2013-09-05 14:02:48 +00:00
A visual tool for wiring the Internet of Things.
2015-04-02 20:19:57 +00:00
![Node-RED: A visual tool for wiring the Internet of Things](http://nodered.org/images/node-red-screenshot.png)
2013-10-02 19:37:28 +00:00
2013-09-05 14:02:48 +00:00
## Quick Start
2015-04-02 20:19:57 +00:00
Check out http://nodered.org/docs/getting-started/ for full instructions on getting
started.
2013-09-05 14:02:48 +00:00
2015-04-02 20:19:57 +00:00
1. `sudo npm install -g node-red`
2. `node-red`
3. Open <http://localhost:1880>
2013-09-05 14:02:48 +00:00
2015-02-06 13:16:46 +00:00
## Getting Help
2013-09-26 20:12:31 +00:00
More documentation can be found [here](http://nodered.org/docs).
2015-04-02 20:19:57 +00:00
For further help, or general discussion, please use the
[mailing list](https://groups.google.com/forum/#!forum/node-red).
2013-09-05 14:02:48 +00:00
2015-04-09 09:21:27 +00:00
## Developers
If you want to run the latest code from git, here's how to get started:
1. Install grunt, the build tool
npm install -g grunt-cli
2. Clone the code:
git clone https://github.com/node-red/node-red.git
2015-04-09 09:21:27 +00:00
cd node-red
3. Install the node-red dependencies
npm install
4. Build the code
grunt build
5. Run
node red.js
2013-09-05 14:02:48 +00:00
## Contributing
2015-04-02 20:19:57 +00: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 19:39:33 +00:00
2016-04-07 20:13:40 +00:00
This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/).
2016-04-07 19:49:44 +00:00
By participating, you are expected to uphold this code. Please report unacceptable
behavior to any of the [project's core team](https://github.com/orgs/node-red/teams/core).
2013-09-05 14:02:48 +00:00
## Authors
Node-RED is a creation of [IBM Emerging Technology](https://www.ibm.com/blogs/emerging-technology/).
2013-09-05 14:02:48 +00:00
2013-09-05 14:04:48 +00:00
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
2013-09-05 14:02:48 +00:00
2014-04-14 08:51:55 +00:00
For more open-source projects from IBM, head over [here](http://ibm.github.io).
2013-09-05 14:02:48 +00:00
## Copyright and license
Copyright 2013, 2016 IBM Corp. under [the Apache 2.0 license](LICENSE).