1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
6 Architecture Overview
Thor Berggren edited this page 2018-10-20 10:00:02 -07:00

This overview is 3+ years old. A lot has changed, moved and is being completely reworked in 0.20.

File Description
red / red.js The main entry point for Node-RED. Provides the programmatic API into the runtime.
red / ui.js Creates the basic express app that serves the UI and related REST endpoints.
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 A singleton event-emitter for broadcasting events through-out the runtime.
red / comms.js Provides a WebSocket endpoint for real-time communication with the editor UI.
red / library.js Provides Flow Library and generic node-type library (e.g. Functions, Templates) functionality.
red / log.js Centralised log handling for the runtime and nodes.
red / storage / index.js Pluggable storage system for the runtime.
red / storage / localfilesystem.js Default storage plugin for the local file system.
red / nodes / index.js Entry point into the nodes API.
red / nodes / Node.js The class prototype all runtime nodes extend.
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 Takes the requested flow configuration and instantiates/starts/stops it.
red / nodes / credentials.js Provides an api to the credential system for load/add/get/delete functionality.