Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.52 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.52 KB

RocketLogger Node.js Web Interface

Features

The RocketLogger web interface features are summarized as follows:

  • static source file serving
  • dynamic site rendering using nunjucks
  • RocketLogger CLI interface from web
  • websockets for server side data streaming using socket.io and zeromq

Installation

To install the webserver and its dependencies and to deploy it as system service, use the provided installer script:

sudo ./install.sh

This script takes care of installing and configuring the additional system and npm package dependencies listed under Dependencies.

To install the node.js server standalone in the source directory, use:

npm install .

When choosing this method, system package dependencies need to be installed and configured manually.

Dependencies and Requirements

  • Server: Node.js v18 or later, NGINX for reverse proxy
  • Client: reasonably recent web browser supporting ECMAScript 6

Node.js server dependencies

  • express - minimalist web framework
  • nunjucks - Jinja2 inspired web template engine
  • socket.io - websockets server side JavaScript library
  • zeromq - ZeroMQ message queueing library
  • gulp - file system listing
  • debug - debugging output utility

Browser client dependencies

  • bootstrap - responsive, mobile-first front-end component library
  • plotly.js - JavaScript plotting library
  • timesync - client-server time synchronization library
  • socket.io-client - websockets client side JavaScript library