mirror of https://github.com/node-red/node-red.git
74 lines
2.0 KiB
Markdown
74 lines
2.0 KiB
Markdown
# Node-RED
|
|
|
|
http://nodered.org
|
|
|
|
[](https://travis-ci.org/node-red/node-red)
|
|
[](https://coveralls.io/r/node-red/node-red?branch=master)
|
|
|
|
A visual tool for wiring the Internet of Things.
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
Check out http://nodered.org/docs/getting-started/ for full instructions on getting
|
|
started.
|
|
|
|
1. `sudo npm install -g node-red`
|
|
2. `node-red`
|
|
3. Open <http://localhost:1880>
|
|
|
|
## Getting Help
|
|
|
|
More documentation can be found [here](http://nodered.org/docs).
|
|
|
|
For further help, or general discussion, please use the
|
|
[mailing list](https://groups.google.com/forum/#!forum/node-red).
|
|
|
|
## 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
|
|
cd node-red
|
|
|
|
3. Install the node-red dependencies
|
|
|
|
npm install
|
|
|
|
4. Build the code
|
|
|
|
grunt build
|
|
|
|
5. Run
|
|
|
|
node red.js
|
|
|
|
## Contributing
|
|
|
|
Before raising a pull-request, please read our
|
|
[contributing guide](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md).
|
|
|
|
This project adheres to the [Contributor Covenant 1.4](http://contributor-covenant.org/version/1/4/).
|
|
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).
|
|
|
|
## Authors
|
|
|
|
Node-RED is a creation of [IBM Emerging Technology](https://www.ibm.com/blogs/emerging-technology/).
|
|
|
|
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
|
|
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
|
|
|
|
For more open-source projects from IBM, head over [here](http://ibm.github.io).
|
|
|
|
## Copyright and license
|
|
|
|
Copyright 2013, 2016 IBM Corp. under [the Apache 2.0 license](LICENSE).
|