lvz-viz

Intro

Visualization of LVZ police ticker.

The official website is hosted at https://lvz-viz.leipzig.codefor.de by OK Lab Leipzig.

Prerequisites

Java

• jdk 17 or higher

We recommend the usage of The Software Development Kit Manager.

Node and pnpm

• node 22.20.0 or higher

We recommend the usage of Node Version Manager.

• pnpm 10.27.0 or higher

Check out the installation instructions.

Angular CLI

• @angular/cli 21.2.5 or higher

Install @angular/cli by running:

pnpm install -g @angular/cli@21

Docker (when running services within docker)

• docker 28.0.2 or higher

Usage

Build and run the app with pnpm and Gradle.

The crawling and indexing of new articles is activated by default. It can be delayed by setting the startup parameter --app.initialDelay=<time in ms> to a high value (e.g. 1800000 for 30 minutes) or by setting an environment variable via export APP_INITIALDELAY=<time in ms>.

Profiles (dev|local|prod|test) can be set by the startup parameter --spring.profiles.active=<profile> or by setting an environment variable via export SPRING_PROFILES_ACTIVE=<profile>.

Please use the prod profile for production systems with a dedicated data volume (see docker-compose.prod.yml).

Read more

Check the documentation for each module.

For frontend check lvz-viz - Frontend.

For docker check lvz-viz - Docker.

Set node version

Use appropriate node and pnpm version via nvm.

nvm use

Starting development

Gradle

For local development and testing you need to start up elasticsearch via docker-compose.

docker compose up -d elasticsearch

You can build and test an executable jar with Gradle.

./gradlew build

You can run a specific test with Gradle.

./gradlew test --tests "*CrawlSchedulerTest"

You can build an executable jar with Gradle and run it as a separate process.

./gradlew assemble -PlocalBuild=true
java -jar build/libs/lvz-viz-*.jar --spring.profiles.active=local

Or you can run the project within Gradle during development.

export SPRING_PROFILES_ACTIVE=local
./gradlew bootRun

Running backend and frontend together

For development, you can use two separate terminals for starting backend and frontend separately. For further information, please refer to the README files.

You could also use the following command in the root folder to start development in one single terminal: Run the following command to install:

# install dependencies
pnpm install

# start both development server
pnpm start

Maintenance

# display dependency updates
./gradlew dependencyUpdates