2013-09-05 14:02:48 +00:00
|
|
|
# Node-RED
|
|
|
|
|
|
2023-09-05 12:17:55 +00:00
|
|
|
https://nodered.org
|
2014-07-24 11:33:57 +00:00
|
|
|
|
2023-04-01 15:39:33 +00:00
|
|
|
[](https://github.com/node-red/node-red/actions?query=branch%3Amaster)
|
2014-04-14 08:51:55 +00:00
|
|
|
|
2019-09-30 12:38:46 +00:00
|
|
|
Low-code programming for event-driven applications.
|
2013-09-05 14:02:48 +00:00
|
|
|
|
2023-09-05 12:17:55 +00:00
|
|
|
|
2013-10-02 19:37:28 +00:00
|
|
|
|
2013-09-05 14:02:48 +00:00
|
|
|
## Quick Start
|
|
|
|
|
|
2023-09-05 12:17:55 +00:00
|
|
|
Check out https://nodered.org/docs/getting-started/ for full instructions on getting
|
2015-04-02 20:19:57 +00:00
|
|
|
started.
|
2013-09-05 14:02:48 +00:00
|
|
|
|
2017-11-30 13:38:22 +00:00
|
|
|
1. `sudo npm install -g --unsafe-perm node-red`
|
2015-04-02 20:19:57 +00:00
|
|
|
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
|
|
|
|
2023-09-05 12:17:55 +00:00
|
|
|
More documentation can be found [here](https://nodered.org/docs).
|
2013-09-26 20:12:31 +00:00
|
|
|
|
2018-05-17 11:17:55 +00:00
|
|
|
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 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:
|
|
|
|
|
|
2016-10-10 10:48:44 +00:00
|
|
|
1. Clone the code:
|
2015-04-09 09:21:27 +00:00
|
|
|
|
2015-06-16 22:20:10 +00:00
|
|
|
git clone https://github.com/node-red/node-red.git
|
2015-04-09 09:21:27 +00:00
|
|
|
cd node-red
|
|
|
|
|
|
2016-10-10 10:48:44 +00:00
|
|
|
2. Install the node-red dependencies
|
2015-04-09 09:21:27 +00:00
|
|
|
|
|
|
|
|
npm install
|
|
|
|
|
|
2016-10-10 10:48:44 +00:00
|
|
|
3. Build the code
|
|
|
|
|
|
|
|
|
|
npm run build
|
2015-04-09 09:21:27 +00:00
|
|
|
|
2016-10-10 10:48:44 +00:00
|
|
|
4. Run
|
2015-04-09 09:21:27 +00:00
|
|
|
|
2016-10-10 10:48:44 +00:00
|
|
|
npm start
|
2015-04-09 09:21:27 +00:00
|
|
|
|
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
|
2018-01-26 14:59:41 +00:00
|
|
|
behavior to any of the project's core team at team@nodered.org.
|
2016-04-07 19:49:44 +00:00
|
|
|
|
2013-09-05 14:02:48 +00:00
|
|
|
## Authors
|
|
|
|
|
|
2022-01-27 12:49:48 +00:00
|
|
|
Node-RED is a project of the [OpenJS Foundation](http://openjsf.org).
|
2017-01-11 15:24:33 +00:00
|
|
|
|
2022-01-27 12:49:48 +00:00
|
|
|
It is maintained by:
|
2013-09-05 14:02:48 +00:00
|
|
|
|
2022-01-27 12:49:48 +00:00
|
|
|
* Nick O'Leary [@knolleary](http://twitter.com/knolleary)
|
|
|
|
|
* Dave Conway-Jones [@ceejay](http://twitter.com/ceejay)
|
|
|
|
|
* And many others...
|
2017-01-11 15:24:33 +00:00
|
|
|
|
2014-04-14 08:51:55 +00:00
|
|
|
|
2013-09-05 14:02:48 +00:00
|
|
|
## Copyright and license
|
|
|
|
|
|
2020-09-29 19:28:15 +00:00
|
|
|
Copyright OpenJS Foundation and other contributors, https://openjsf.org under [the Apache 2.0 license](LICENSE).
|
