From ec11f67050d34cf0118e36022dfb80100cb16f04 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Thu, 21 Aug 2014 06:34:13 -0700 Subject: [PATCH] Created Architecture Overview (markdown) --- Architecture-Overview.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Architecture-Overview.md diff --git a/Architecture-Overview.md b/Architecture-Overview.md new file mode 100644 index 0000000..5c415ec --- /dev/null +++ b/Architecture-Overview.md @@ -0,0 +1,16 @@ +| File | Description | +|:-----|:------------| +| [red / **red.js**](https://github.com/node-red/node-red/blob/master/red/red.js) | The main entry point for Node-RED. Provides the programmatic API into the runtime. | +| [red / **ui.js**](https://github.com/node-red/node-red/blob/master/red/ui.js) | Creates the basic express app that serves the UI and related REST endpoints. | +| [red / **server.js**](https://github.com/node-red/node-red/blob/master/red/server.js) | The heart of the runtime. Adds runtime API endpoints to the express app created by `ui.js`. Provides `start`/`stop` functions for the runtime. | +| [red / **events.js**](https://github.com/node-red/node-red/blob/master/red/events.js) | A singleton event-emitter for broadcasting events through-out the runtime. | +| [red / **comms.js**](https://github.com/node-red/node-red/blob/master/red/comms.js) | Provides a WebSocket endpoint for real-time communication with the editor UI. | +| [red / **library.js**](https://github.com/node-red/node-red/blob/master/red/library.js) | Provides Flow Library and generic node-type library (e.g. Functions, Templates) functionality. | +| [red / **log.js**](https://github.com/node-red/node-red/blob/master/red/log.js) | Centralised log handling for the runtime and nodes. | +| [red / storage / **index.js**](https://github.com/node-red/node-red/blob/master/red/storage/index.js) | Pluggable storage system for the runtime. | +| [red / storage / **localfilesystem.js**](https://github.com/node-red/node-red/blob/master/red/storage/localfilesystem.js) | Default storage plugin for the local file system. | +| [red / nodes / **index.js**](https://github.com/node-red/node-red/blob/master/red/nodes/index.js) | Entry point into the nodes API. | +| [red / nodes / **Node.js**](https://github.com/node-red/node-red/blob/master/red/nodes/Node.js) | The class prototype all runtime nodes extend. | +| [red / nodes / **registry.js**](https://github.com/node-red/node-red/blob/master/red/nodes/registry.js) | The registry of all node types. Responsible for discovering the installed nodes and loading them into the runtime. | +| [red / nodes / **flows.js**](https://github.com/node-red/node-red/blob/master/red/nodes/flows.js) | Takes the requested flow configuration and instantiates/starts/stops it. | +| [red / nodes / **credentials.js**](https://github.com/node-red/node-red/blob/master/red/nodes/credentials.js) | Provides an api to the credential system for load/add/get/delete functionality. | \ No newline at end of file