SSteP-KiZ Shared Library

This is a TypeScript Library containing all shared classes and type definitions of the SSteP-KiZ project.

1. Overview

The shared library is divided into the following sections:

Aggregator: Contains library shared between Aggregator UI and Aggregator Backend.
Common: Contains commonly used definitions.
Feedback: Contains all necessary definitions for the Live-Feedback of the patient.
IMeRa API: Contains all IMeRa API specific definitions.
Game: Contains all necessary definitions for the gamification API.
Peer: Contains all necessary definitions for the Peer-to-Peer connection.
Sensors: Contains all necessary definitions for the Sensor data.
Signalling: Contains all the necessary definitions for connection establishment of the Peer-to-Peer connection.

Use the following command to install all external dependencies:

/shared$ npm install

Use the following command to build the library:

/shared$ npm run build

This will build the library to the directory /shared/dist.

The library can be linted using the following command:

$ npm run lint

The workspace can be cleaned up using the following command:

$ npm run clean

This will remove the directory /shared/dist with all its files.