1.0.0 • Published 9 months ago
@arendi/rms v1.0.0
RMS WebSocket client API
This package contains JavaScript source files for communicating with the Arendi RMS server.
Prerequisite
WebSocket server
An instance of the WebSocket server must be running in order for the following sample code to run. To install the WebSocket server, download and execute the installer from https://www.arendi.ch/rms
Node
Node.js (at least v16) must be installed on the target machine: https://nodejs.org
Installation
Install with npm:
npm install "@arendi/rms"Usage
Development
Build
To build the project from source, perform the following steps:
- clone the repository to a local folder:
- Open the created folder and run
```bash
npm install
npm run build
```
The 'npm run build' command described above must be executed in order to compile and copy any changes made to the source files located in the src directory
#### Test
- Run test
```bash
npm run test
```1.0.0
9 months ago