diff --git a/README.md b/README.md index 55b7a159..8f4f358f 100644 --- a/README.md +++ b/README.md @@ -5,41 +5,48 @@ For architecture consider the files in the `doc` and `adr` folder. - [Setting up the Development Environment](#setting-up-the-development-environment) - - [PostgreSQL Server](#postgresql-server) - - [Markdown](#markdown) - - [Render Markdown embedded PlantUML](#render-markdown-embedded-plantuml) - - [Render Markdown Embedded Mermaid Diagrams](#render-markdown-embedded-mermaid-diagrams) - - [IDE Specific Settings](#ide-specific-settings) - - [IntelliJ IDEA](#intellij-idea) - - [Other Tools](#other-tools) + - [PostgreSQL Server](#postgresql-server) + - [Markdown](#markdown) + - [Render Markdown embedded PlantUML](#render-markdown-embedded-plantuml) + - [Render Markdown Embedded Mermaid Diagrams](#render-markdown-embedded-mermaid-diagrams) + - [IDE Specific Settings](#ide-specific-settings) + - [IntelliJ IDEA](#intellij-idea) + - [Other Tools](#other-tools) - [Running the SQL files](#running-the-sql-files) - - [For RBAC](#for-rbac) - - [For Historization](#for-historization) + - [For RBAC](#for-rbac) + - [For Historization](#for-historization) - [Coding Guidelines](#coding-guidelines) - - [Directory and Package Structure](#directory-and-package-structure) - - [General Directory Structure](#general-directory-structure) - - [Source Code Package Structure](#source-code-package-structure) - - [Run Tests from Command Line](#run-tests-from-command-line) - - [Spotless Code Formatting](#spotless-code-formatting) - - [JaCoCo Test Code Coverage Check](#jacoco-test-code-coverage-check) - - [PiTest Mutation Testing](#pitest-mutation-testing) - - [Remark](#remark) - - [OWASP Security Vulnerability Check](#owasp-security-vulnerability-check) - - [Dependency-License-Compatibility](#dependency-license-compatibility) - - [Dependency Version Upgrade](#dependency-version-upgrade) + - [Directory and Package Structure](#directory-and-package-structure) + - [General Directory Structure](#general-directory-structure) + - [Source Code Package Structure](#source-code-package-structure) + - [Run Tests from Command Line](#run-tests-from-command-line) + - [Spotless Code Formatting](#spotless-code-formatting) + - [JaCoCo Test Code Coverage Check](#jacoco-test-code-coverage-check) + - [PiTest Mutation Testing](#pitest-mutation-testing) + - [Remark](#remark) + - [OWASP Security Vulnerability Check](#owasp-security-vulnerability-check) + - [Dependency-License-Compatibility](#dependency-license-compatibility) + - [Dependency Version Upgrade](#dependency-version-upgrade) +- [Biggest Flaws in our Architecture](#biggest-flaws-in-our-architecture) + - [The RBAC System is too Complicated](#the-rbac-system-is-too-complicated) + - [The Mapper is Error-Prone](#the-mapper-is-error-prone) + - [Too Many Business-Rules Implemented in Controllers](#too-many-business-rules-implemented-in-controllers) - [How To ...](#how-to-...) - - [How to Configure .pgpass for the Default PostgreSQL Database?](#how-to-configure-.pgpass-for-the-default-postgresql-database?) - - [How to Run the Tests Against a Local User-Space Podman Daemon?](#how-to-run-the-tests-against-a-local-user-space-podman-daemon?) - - [Install and Run Podman](#install-and-run-podman) - - [Use the Command Line to Run the Tests Against the Podman Daemon ](#use-the-command-line-to-run-the-tests-against-the-podman-daemon-) - - [Use IntelliJ IDEA Run the Tests Against the Podman Daemon](#use-intellij-idea-run-the-tests-against-the-podman-daemon) - - [~/.testcontainers.properties](#~/.testcontainers.properties) - - [How to Run the Tests Against a Remote Podman or Docker Daemon?](#how-to-run-the-tests-against-a-remote-podman-or-docker-daemon?) - - [How to Run the Application on a Different Port?](#how-to-run-the-application-on-a-different-port?) - - [How to Use a Persistent Database for Integration Tests?](#how-to-use-a-persistent-database-for-integration-tests?) - - [How to Amend Liquibase SQL Changesets?](#how-to-amend-liquibase-sql-changesets?) - - [How to Re-Generate Spring-Controller-Interfaces from OpenAPI specs?](#how-to-re-generate-spring-controller-interfaces-from-openapi-specs?) - - [How to Generate Database Table Diagrams?](#how-to-generate-database-table-diagrams?) + - [How to Run the Application With Other Profiles, e.g. production](#) + - [How to Do a Clean Run of the Application](#how-to-do-a-clean-run-of-the-application) + - [How to Configure .pgpass for the Default PostgreSQL Database?](#how-to-configure-.pgpass-for-the-default-postgresql-database?) + - [How to Run the Tests Against a Local User-Space Podman Daemon?](#how-to-run-the-tests-against-a-local-user-space-podman-daemon?) + - [Install and Run Podman](#install-and-run-podman) + - [Use the Command Line to Run the Tests Against the Podman Daemon ](#use-the-command-line-to-run-the-tests-against-the-podman-daemon-) + - [Use IntelliJ IDEA Run the Tests Against the Podman Daemon](#use-intellij-idea-run-the-tests-against-the-podman-daemon) + - [~/.testcontainers.properties](#~/.testcontainers.properties) + - [How to Run the Tests Against a Remote Podman or Docker Daemon?](#how-to-run-the-tests-against-a-remote-podman-or-docker-daemon?) + - [How to Run the Application on a Different Port?](#how-to-run-the-application-on-a-different-port?) + - [How to Use a Persistent Database for Integration Tests?](#how-to-use-a-persistent-database-for-integration-tests?) + - [How to Amend Liquibase SQL Changesets?](#how-to-amend-liquibase-sql-changesets?) + - [How to Re-Generate Spring-Controller-Interfaces from OpenAPI specs?](#how-to-re-generate-spring-controller-interfaces-from-openapi-specs?) + - [How to Generate Database Table Diagrams?](#how-to-generate-database-table-diagrams?) + - [How to Add (Real) Admin Users](#how-to-add-(real)-admin-users) - [Further Documentation](#further-documentation) @@ -205,7 +212,7 @@ To generate the TOC (Table of Contents), a little bash script from a Given this is in PATH as `md-toc`, use: ```shell -md-toc