Blicc

Blicc is a lightweight, user-friendly and secure data monitoring platform.

Docs

• Codebase
• Plugin Development
• Pipeline Setup

Quick start guide

Prerequisites

You need to have Git, Docker, Node.js, Yarn and Golang installed to be able to run and build the project.

By using VS Code you can make use of the provided project settings.

Versions

A greater or equal version of the listed softwares is required.

• Git 2.21.1
• Docker 19.03.5
• Node.js 12.13.1
• Yarn 1.19.2
• Go 1.14.2

To run Docker Desktop on Windows 10 either Pro or Enterprise version is required.

Clone

To clone the repository you need to use the --recurse-submodules tag to also clone the submodules.

git clone --recurse-submodules git@github.com:blicc-org/blicc.git

Setup project

If all the prerequisites have been installed, a rsa key needs to be generated as well as .env files created.

Generate RSA Key

The rsa key is used for authorizing users between the services. You need to generate a public and private key inside an /certs folder in the root directory if the monorepo. To do so you can use the following commands:

mkdir -p certs
openssl genrsa -out ./certs/rsa.pem 2048
openssl rsa -in ./certs/rsa.pem -outform PEM -pubout -out ./certs/rsa_pub.pem

The rsa keys are used for generating and validating JWT.

Environment variables

Examples for the environment variables are stored inside .env.example files in the following locations:

    project/        # root folder
    ├── api         # resource management service
    ├── delivery    # data delivery service
    ├── plugins     # plugins for visualizing data

To set the environment variables you simply need to make copies of the .env.example files and name them .env. Modifying the values is not required.

The resource management service won't send mails on registration unless you set proper mail server credentials.

Build and Run

To install all dependencies in the services run the following command:

yarn install

To run the project for local development simply run:

yarn start

The container of the local docker compose cluster are mapped to the source code. They restart on any code modification detected by nodemon and reflex.

Access

Once all the services are running healthy they are available under the following links:

• Frontend (PWA)
• Resource management service docs
• Data delivery service docs

To check if the services are healthy simply run docker ps.

License

Copyright (c) Thilo Ilg. All rights reserved.

MIT license, see the LICENSE file.