main_java

Project Documentation - Index

📌 KI-Kontext: CLAUDE.md | Einstieg: README.md
Last Updated: 2026-03-14
Status: ✅ Consolidated and up-to-date

---

🤖 KI-Kontext (Claude)

Datei	Inhalt
CLAUDE.md	⭐ Automatisch geladener Projekt-Kontext für Claude
root/app/jeeeraaah/CLAUDE.md	App-Architektur, Datenmodell, JPMS-Konventionen

---

🚀 Quick Start

Document	Description
README.md	⭐ Main documentation - Start here!
GETTING-STARTED.md	Complete getting started guide
todo.md	Current task list and priorities
SCRIPTS-OVERVIEW.md	Overview of all scripts & aliases

---

🏗️ Architecture & JPMS

Document	Description
JPMS-REFERENCE.md	⭐ Complete JPMS reference guide (NEW - consolidated)
root/app/jeeeraaah/doc/md/jpms in action - jeeeraaah/jpms in action - jeeeraaah.md	📚 JPMS in Action - Publication
root/app/jeeeraaah/doc/md/modular-software-in-java/modular-software-in-java.md	📚 Modular Software in Java - Publication

---

🔧 Build & Development

Document	Description
VSCODE-ERRORS-EXPLAINED-2026-03-01.md	⚠️ Why VS Code shows errors
VSCODE-TASKS-GUIDE.md	⭐ VS Code Tasks & Shortcuts (Liberty, Frontend)
BUILD-TROUBLESHOOTING.md	Build troubleshooting guide
bom/readme.md	Bill of Materials (BOM)

---

🔑 Security & IAM

Document	Description
IAM-KEYCLOAK-LIBERTY-GUIDE.md	⭐ Complete IAM guide
config/CREDENTIALS.md	All credentials reference
config/KEYCLOAK-ADMIN-CONSOLE.md	Keycloak admin console guide
config/JWT-TROUBLESHOOTING.md	JWT troubleshooting

---

📡 API Documentation

Document	Description
API-DOCUMENTATION.md	⭐ REST API documentation guide
http://localhost:9080/openapi/ui	Interactive API explorer (when backend running)
http://localhost:9080/openapi	OpenAPI specification (YAML/JSON)

---

🐳 Docker & Infrastructure

Document	Description
config/shared/docker/LIB-TEST-FIX.md	lib_test database automation
config/shared/docker/MULTI-DB-SOLUTION.md	Multi-database setup
config/shared/docker/initdb/README.md	Database initialization

---

📝 Data Model & Architecture

Application Architecture

| Document | Description | |———-|————-| | root/app/jeeeraaah/doc/md/architecture/requirements.md | Requirements | | root/app/jeeeraaah/doc/md/datamodel/datamodel.md | Base data model | | root/app/jeeeraaah/doc/md/datamodel/datamodel-extended.md | Extended data model |

Backend

| Document | Description | |———-|————-| | root/app/jeeeraaah/backend/api/ws_rs/README.md | Backend REST API documentation |

Frontend

| Document | Description | |———-|————-| | root/lib/fx/comp/readme.md | JavaFX Component Framework | | root/lib/fx/comp/doc/fx-comp-architecture.md | FX Component Architecture |

Libraries

| Document | Description | |———-|————-| | root/lib/docker_health/README.md | Docker Health Check Library | | root/lib/mp_config/README.md | MicroProfile Config Integration |

---

🛠️ Configuration

Document	Description
config/CONFIGURATION-GUIDE.md	Configuration guide
config/SINGLE-POINT-OF-TRUTH.md	Configuration single point of truth
config/STRUCTURE.md	Project structure
config/QUICK-COMMANDS.md	Frequently used commands
config/shared/wsl/aliases.sh	⭐ All project aliases (includes Liberty!)

---

🔧 IntelliJ IDEA

Document	Description
config/INTELLIJ-APPLICATION-RUN-CONFIG.md	IntelliJ application run configs
config/FRESH-CLONE-SETUP.md	Setup from fresh clone

---

🐛 Troubleshooting

Document	Description
config/TROUBLESHOOTING.md	⭐ General troubleshooting
config/JWT-TROUBLESHOOTING.md	JWT/Authentication issues
VSCODE-ERRORS-EXPLAINED-2026-03-01.md	VS Code false-positive errors

---

📚 Archive & History

Historical Reports (2026-02)

Location: docs/archive/reports-2026-02/

• ABSCHLUSS-2026-02-20.md - Completion report
• KONSOLIDIERUNG-2026-02-20.md - Package reorganization
• PROJECT-CONSOLIDATION-REPORT.md - Consolidation report
• FINAL-FIXES-SUMMARY.md - Final fixes summary
• HAMCREST-TO-ASSERTJ-MIGRATION-COMPLETE.md - Test migration report
• TODO-16-17-COMPLETION-REPORT.md - TODOs completion
• GANTTAPPRUNNER-FIX-SUMMARY.md - GanttAppRunner fix
• SOLUTION-SUMMARY.md - Keycloak login solution

Historical Fixes (2026-02)

Location: docs/archive/fixes-2026-02/

• FIX-INTELLIJ-MODULE-NOT-FOUND.md
• FIX-MODULE-NOT-FOUND-KEYCLOAK-ADMIN.md
• GANTTAPPRUNNER-INTELLIJ-FIX.md
• KEYCLOAK-AUTO-FIX-SOLUTION.md
• KEYCLOAK-AUTOFIX-NO-MAVEN.md
• URL-DEPRECATED-AUTOFIX-SOLUTION.md
• PORTABLE-SOLUTION.md

Older Archives

Location: config/archive/

• docs-20260123/ - Initial archive (7 files)
• docs-20260209/ - Main cleanup (29+ files)
• docs-20260209-final/ - Final cleanup (7 files)

---

📊 Konsolidierungshistorie

2026-03-14:

• ✅ CLAUDE.md (root) und root/app/jeeeraaah/CLAUDE.md erstellt
• ✅ BUILD-STATUS-2026-02-28.md nach docs/archive/2026-03/ verschoben
• ✅ DOCUMENTATION-CONSOLIDATION-PLAN.md nach docs/archive/2026-03/ verschoben
• ✅ config/STATUS.md (leer) gelöscht

2026-03-01:

• ✅ 40 → 11 root-level MD files (82% reduction)
• ✅ 15 files archived (historical reports & fixes)
• ✅ 7 JPMS documents → 1 JPMS-REFERENCE.md
• ✅ 3 Liberty aliases added (ruu-liberty-start/run/stop)

---

📖 Reading Order for New Developers

1. CLAUDE.md - KI-Kontext & schnelle Orientierung
2. README.md - Start here!
3. GETTING-STARTED.md - Complete guide
4. VSCODE-TASKS-GUIDE.md - ⚡ Liberty & Frontend mit Shortcuts starten
5. config/CREDENTIALS.md - All credentials
6. JPMS-REFERENCE.md - JPMS guide
7. IAM-KEYCLOAK-LIBERTY-GUIDE.md - IAM setup
8. API-DOCUMENTATION.md - REST API guide
9. config/QUICK-COMMANDS.md - Common commands
10. todo.md - Current tasks

---

🎯 Essential Tools & Scripts

Useful Scripts

• safe-git-push.sh - Safe git push helper
• setup-fresh-clone.sh - Fresh clone setup
• count-jpms-encapsulation.py - JPMS metrics analysis (in root/)

Useful Aliases (see aliases.sh)

• ruu-help - Show all available aliases
• ruu-docker-startup - Start all Docker services
• ruu-liberty-start - Start Liberty backend (NEW!)
• ruu-dash - Start JavaFX frontend
• ruu-build - Build the project

---

Need help?
📘 config/TROUBLESHOOTING.md | 🐛 VSCODE-ERRORS-EXPLAINED-2026-03-01.md

For publications:
📚 JPMS in Action | Modular Software in Java

This site is open source. Improve this page.