Skip to content

KarstenMalle/BachelorProject

Repository files navigation

Motivation

Website for Digital Twin as a Service (DTaaS) software. This software shall be used for creating a Digital Twin support platform for SMEs. A brief overview of the software is available in this presentation.

This is a mono repo containing code for both the client (web browser) and server code.

Before Installing the Environment

Give Linux user sudo privileges, if your user already has sudo privileges you can skip this step.

  1. On start up hold shift.
  2. Select the second option, "Advanced options for Ubuntu".
  3. Select the second option, "Ubuntu, with Linux 5.15.0-60-generic (recovery mode)".
  4. On the "Recovery Menu" select "root" and enter your password.
  5. Use the following:
usermod -aG sudo <username>
exit
  1. Select "resume".

Optional: Once you're back on the desktop check if your user has sudo privileges:

groups <username>

Install the Environment

sudo bash script/install.bash

For Client app (serves React Website)

cd client
yarn install    #install the nodejs dependencies
yarn syntax     #perform linting and static analysis
yarn build      #build the react app into build/ directory

#one of the environments; specify only one; "dev" used the REACT_APP_ENV is not set
export REACT_APP_ENV= "dev | test | prod"   
yarn configapp

yarn start      #start the application
yarn test       #UI testing of the application
yarn clean      #clean the directory of temporary files

Infrastructure Components

The application requires the following open-source components.

  1. Traefik
  2. InfluxDB
  3. Grafana

See each of the directories to launch the respective docker services.

TODO: docker-compose file for all the infrastructure components.


For server apps

The server apps shall be a set of microservices.

cd server/<microservice-folder>
yarn install    #install the nodejs dependencies
yarn syntax     #perform linting and static analysis
yarn build      #compile ES6 files into ES5 javascript files and copy all JS files into build/ directory
yarn test       #test the application

#optional step: set the environment variables in .env file

yarn start      #start the application
yarn clean      #clean the directory of temporary files

License

This software is owned by The INTO-CPS Association and is licensed under the terms of the INTO-CPS Association.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published