Build Documentation

Requirements

• Java Version 17.0.1 or higher
• Node.js Version 20.0.0 or higher
• Docker Desktop

Startup

First, build the application JAR from the backend directory with:

./mvnw package -DskipTests

Start Frontend, Backend and Pulsar instance without demodata

Start Docker Desktop and create the pulsar setup from the root-directory with:

echo BACKEND_IP=localhost >> .env

docker-compose --profile backend --profile frontend up --build -d

Start Frontend, Backend and Pulsar instance with demodata

Start Docker Desktop and create the pulsar setup from the root-directory with:

echo BACKEND_IP=localhost >> .env

docker-compose --profile backend --profile frontend --profile demodata -f docker-compose.yml -f docker-compose-setup.yml up --build -d

Notes:

• The docker-compose.yml includes the pulsar, backend and frontend services.
• The docker-compose-setup.yml includes services for the local demodata setup. -f selects the files used for the startup.
• --build is needed for the first startup, or when the demodata docker images are changed
• -d runs the container in the background, so u can close the terminal without terminating the app itself.
• --profile demodata is needed when you want to create the demo topology and start the demo producers & consumers, that will continuously send and receive messages
• --profile backend is needed when you want to start the backend via the docker-compose setup. See below for starting it manually.
• --profile frontend is needed when you want to start the frontend via the docker-compose setup.