Flame HUB 🔥

This repository contains the HUB ecosystem of FLAME.

🚧 Work in Progress

The HUB ecosystem is currently in active development and not usable for production yet.

Table of Contents

• Packages
• Usage
• Contributing
• Credits
• License

Packages

The repository contains the following packages:

General

• @privateaim/core 🧱: This package contains common constants, functions, types, ...
• @privateaim/storage-kit 🧱: This package contains an api-client, types and utils in the context of the storage service, ...

Client

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

Server

• @privateaim/server-kit 🧱: This package contains common constants, functions, types, ... for the server side.
• @privateaim/server-core 🌴: This package contains aggregators, components and many more.
• @privateaim/server-realtime 🚄: This package contains the realtime application which connects the API with socket based clients.
• @privateaim/server-analysis-manager 🏭: This package contains the analysis manager, which is responsible to build and distribute an analysis.

Usage

Development

1. Installation & Build

Download the source code.

$ git clone https://github.com/PrivateAim/hub
$ cd hub

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

2. Configuration

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

3. Execution

Start the applications/services in a single terminal window (or as background process) with the following command:

$ npm run server-core

$ npm run client-ui

$ npm run server-realtime

$ npm run server-analysis-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.

License

Made with 💚

Published under Apache 2.0.