docs(): update readme files

inpercima · inpercima · commit a90d77704bdb · 2025-05-31T08:03:47.000+02:00
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
-# lvz-viz
+# LVZ Polizeiticker
 
-[![Build Status](https://travis-ci.org/sepe81/lvz-viz.svg?branch=master)](https://travis-ci.org/sepe81/lvz-viz)
 ![GitHub license](https://img.shields.io/github/license/CodeforLeipzig/lvz-viz.svg)
-[![Code Climate](https://codeclimate.com/github/CodeforLeipzig/lvz-viz/badges/gpa.svg)](https://codeclimate.com/github/CodeforLeipzig/lvz-viz)
-
 [![Java CI with Gradle](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/java_ci.yml/badge.svg)](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/java_ci.yml)
+[![Node CI](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/node_ci.yml/badge.svg)](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/node_ci.yml)
+[![Build Fullstack App](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/build.yml/badge.svg)](https://github.com/CodeforLeipzig/lvz-viz/actions/workflows/build.yml)
 
 ## Intro
 
@@ -13,104 +12,78 @@ Visualization of [LVZ police ticker](https://www.lvz.de/Leipzig/Polizeiticker/Po
 The official website is hosted at <https://lvz-viz.leipzig.codefor.de>
 by [OK Lab Leipzig](http://codefor.de/projekte/2014-07-01-le-lvz_polizeiticker_visualisierung.html).
 
-## Usage
-
-Build and run the app with [npm](https://www.npmjs.com), [Grunt](http://gruntjs.com/) and [Gradle](https://gradle.org).
-
-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>`.
+## Prerequisites
 
-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>`.
+### Node, npm or pnpm
 
-Please use the `prod` profile for production systems with a dedicated data volume (see `docker-compose.prod.yml`).
+* `node 22.14.0` or higher in combination with
+  * `npm 10.9.2` or higher or
+  * `pnpm 10.4.1` or higher, used in this repository
 
-### npm and Grunt
+It's recommended to use [nvm (Node version Manager)](https://github.com/nvm-sh/nvm).
 
-Use appropriate node and npm version via [nvm](https://github.com/nvm-sh/nvm#nvmrc).
+Install pnpm by running:
 
 ```bash
-nvm use
+npm install -g pnpm@10.4.1
 ```
 
-Download client js dependencies with npm and package them with Grunt.
+This repo uses `pnpm` as package manager.
+You can also use `npm` for your local work but changes will be made by `pnpm` only.
 
-```bash
-npm install --no-progress
-npm run grunt-build
-```
+### Angular CLI
 
-### Gradle
+* `@angular/cli 19.2.8` or higher
 
-For local development and testing you need to startup elasticsearch via [docker-compose](https://docs.docker.com/compose/).
+Install @angular/cli by running:
 
 ```bash
-docker-compose up -d elasticsearch
+pnpm install -g @angular/cli@19
 ```
 
-You can build and test an executable jar with gradle.
+### Java
 
-```bash
-./gradlew build
-```
+* `jdk 17` or higher
 
-You can run a specific test with gradle.
+### Docker (when running services within docker)
 
-```bash
-./gradlew test --tests *CrawlSchedulerTest
-```
+* `docker 28.0.2` or higher
+* `docker compose v2.34.0` or higher
 
-You can build an executable jar with gradle and run it as a separate process.
+## Getting started
 
 ```bash
-./gradlew assemble
-java -jar build/libs/lvz-viz-*.jar --spring.profiles.active=local
+# clone project
+git clone https://github.com/CodeforLeipzig/lvz-viz
+cd lvz-viz
 ```
 
-Or you can simply run the project within gradle during development.
+### Read more
 
-```bash
-export SPRING_PROFILES_ACTIVE=local
-./gradlew bootRun
-```
+Check the documentation for each module/component.
 
-### Docker
+For frontend check [lvz-viz - frontend](./frontend/README.md).
 
-You can build and run the app within a Docker container.
+For backend check [lvz-viz - backend](./backend/README.md).
 
-Required version for the multi-stage build: Docker 19.03+
+For docker check [lvz-viz - docker](./README_docker.md).
 
-```bash
--- Build or rebuild services
-docker-compose build
--- Create and start containers
-docker-compose up -d
-```
+### Install Tools
 
-```bash
--- Build services and start containers with dev profile
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
-```
+Some tools are both used by backend and frontend.
+Run the following command to install:
 
 ```bash
--- Build services and start containers with prod profile
-docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build
+pnpm install
 ```
 
-```bash
--- View output from containers
-docker-compose logs -f
-```
+### Starting the application
 
-```bash
--- Stop and remove containers, networks, images, and volumes
-docker-compose down
-```
+For development, you can use two separate terminals to start the backend and frontend separately.
+You can find more information in the README files in the separate folders.
 
-## Maintenance
+You can also use the following command in the root directory to start in a single terminal:
 
 ```bash
--- Display dependency updates
-./gradlew dependencyUpdates
+pnpm start
 ```
diff --git a/README_docker.md b/README_docker.md
@@ -0,0 +1,34 @@
+# LVZ Polizeiticker - docker
+
+## Getting started
+
+You can build and run the app within a Docker container.
+
+Required version for the multi-stage build: Docker 19.03+
+
+```bash
+-- Build or rebuild services
+dockercompose build
+-- Create and start containers
+docker compose up -d
+```
+
+```bash
+-- Build services and start containers with dev profile
+docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build
+```
+
+```bash
+-- Build services and start containers with prod profile
+docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build
+```
+
+```bash
+-- View output from containers
+docker compose logs -f
+```
+
+```bash
+-- Stop and remove containers, networks, images, and volumes
+docker compose down
+```
diff --git a/backend/README.md b/backend/README.md
@@ -0,0 +1,62 @@
+# LVZ Polizeiticker - backend
+
+## Getting started
+
+```bash
+# all commands used in ./backend
+cd backend
+```
+
+## Usage
+
+### General
+
+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`).
+
+### Run in development mode
+
+For local development and testing you need to startup elasticsearch via [docker-compose](https://docs.docker.com/compose/).
+
+```bash
+docker-compose up -d elasticsearch
+```
+
+You can build and test an executable jar with gradle.
+
+```bash
+./gradlew build
+```
+
+You can run a specific test with gradle.
+
+```bash
+./gradlew test --tests *CrawlSchedulerTest
+```
+
+You can build an executable jar with gradle and run it as a separate process.
+
+```bash
+./gradlew assemble
+java -jar build/libs/lvz-viz-*.jar --spring.profiles.active=local
+```
+
+Or you can simply run the project within gradle during development.
+
+```bash
+export SPRING_PROFILES_ACTIVE=local
+./gradlew bootRun
+```
+
+## Maintenance
+
+```bash
+-- Display dependency updates
+./gradlew dependencyUpdates
+```
diff --git a/frontend/README.md b/frontend/README.md
@@ -1,40 +1,22 @@
-# LVZ Polizeiticker
-
-[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](../LICENSE)
-
-Visualization of LVZ police ticker.
-
-## Prerequisites
-
-### Angular CLI
-
-* `@angular/cli 19.2.8` or higher
-
-### Node, npm or pnpm
-
-* `node 22.14.0` or higher in combination with
-  * `npm 10.9.2` or higher or
-  * `pnpm 10.7.0` or higher, used in this repository
+# LVZ Polizeiticker - frontend
 
 ## Getting started
 
 ```bash
-# clone project
-git clone
-cd lvz-viz
+# all commands used in ./frontend
+cd frontend
 
 # install tools and frontend dependencies
 pnpm install
 ```
 
-Create environment files for `development mode` and `production mode`.
+Create environment file for `development mode`.
 
 ```bash
 cp src/environments/environment.ts src/environments/environment.dev.ts
-cp src/environments/environment.ts src/environments/environment.prod.ts
 ```
 
-**Note**: These files will not be under version control but listed in .gitignore.
+**Note**: These file will not be under version control but listed in .gitignore.
 
 ## Usage
 
@@ -45,28 +27,19 @@ For the other options your app should run on a server which you like.
 
 ### Run in development mode
 
-If you want to work with mock data, start the mock server in a separate terminal, reachable on [http://localhost:3000/](http://localhost:3000/).
-
-Comment out the providers in `SearchComponent` and `StatisticComponent` to use the mock services.
-Update your `environment.dev.ts` file `api` to `http://localhost:3000/`.
-
-```bash
-pnpm run mock
-```
-
 ```bash
 # build, reachable on http://localhost/app/path/to/dist/
-pnpm run build:dev
+pnpm build:dev
 
 # build and starts a server, rebuild after changes, reachable on http://localhost:4200/
-pnpm run start
+pnpm start
 ```
 
 ### Package
 
 ```bash
 # build in production mode, compressed
-pnpm run build:prod
+pnpm build:prod
 ```
 
 ### Tests
@@ -97,14 +70,13 @@ Change for `production mode` the option `production` to `true`.
 ### `api`
 
 Defines the URL to the backend.
-If you want to work with mock data, use [http://localhost:3000/](http://localhost:3000/).
 
 * default: `./api/`
 * type: `string`
 
 ### `appname`
 
-Application-wide title of the app, displayed in title and toolbar.
+Applicationwide title of the app, displayed in title and toolbar.
 
 * default: `LVZ Polizeiticker`
 * type: `string`
@@ -119,10 +91,10 @@ Defines whether the app is in production or not.
 
 ### `theme`
 
-Name of a build-in theme from angular-material or a custom light or dark theme.
+Name of a pre-build-theme or a custom theme.
 
-* default: `indigo-pink`
+* default: `rose-red`
 * type: `string`
-* values: `deeppurple-amber`/`indigo-pink`/`pink-bluegrey`/`purple-green`/`custom-light`/`custom-dark`
+* values: `rose-red`/`azure-blue`/`magenta-violet`/`cyan-orange`/`custom`
 
-To create a custom light or dark theme just edit the colors and themes in `themes.scss`.
+To modify the custom theme just edit the colors and themes in `themes.scss`.
