Central 🐋

This repository contains the main central packages of the Personal Health Train (PHT).

Table of Contents

• Installation & Build
• Configuration
• Packages
• Usage
• Contributing
• Credits
• License

Installation & Build

Download the source code.

$ git clone https://github.com/PHT-Medic/central
$ cd central

In addition, Node.js must be installed on the host machine, to start packages and to install required dependencies. To install the dependencies, run:

$ npm i

To build all packages, run:

$ npm run build

Configuration

Read the README.md in each package directory. Each package must be configured individually.

Packages

The repository contains the following packages:

General

• @personalhealthtrain/core 🧱: This package contains common constants, functions, types, ...

Client

• @personalhealthtrain/client-ui 🧸: This package contains the User Interface.
• @personalhealthtrain/client-vue 🧩: This package contains vue components for frontend applications.

Server

• @personalhealthtrain/server-core 🧱: This package contains common constants, functions, types, ... for the server side.
• @personalhealthtrain/server-api 🌴: This package contains aggregators, components and many more.
• @personalhealthtrain/server-realtime 🚄: This package contains the realtime application which connects the API with socket based clients.
• @personalhealthtrain/server-train-manager 🏭: This package contains the train manager, which is responsible to route, build and extract a train.

Usage

Start the ui-, api-, & realtime-application in a single terminal window (or as background process) with the following command:

$ npm run server-api

$ npm run client-ui

$ npm run server-realtime

$ npm run server-train-manager

Contributing

Before starting to work on a pull request, it is important to review the guidelines for contributing and the code of conduct. These guidelines will help to ensure that contributions are made effectively and are accepted.

Credits

If you have any questions, feel free to contact the author & creator Peter Placzek of the project. The project was initial developed during this bachelor thesis, and he worked after that time as employee on the project.

License

Made with 💚

Published under MIT License.