How miledrousset/siamois works
Project Type and Purpose
• This is a monolithic, full-stack Java web application (Spring Boot + JSF/PrimeFaces) augmented by a sibling SCSS/CSS “primefaces-themes” module.
• It serves as a rich-client browser UI backed by REST/JSF controllers, domain services, JPA repositories, PostgreSQL persistence, Liquibase migrations, and external Thesaurus/ARK resolution APIs.
High-Level Architectural Components
a. Frontend (Presentation)
• JSF + PrimeFaces pages & dialogs (under src/main/resources/META-INF/resources).
• Managed Beans & ViewModels (fr.siamois.ui.bean, ui.lazydatamodel, ui.viewmodel).
• Controllers & Redirectors (fr.siamois.ui.api, ui.redirection)
• Converters & Validators (ui.bean.converter, person/verifier).
• SCSS/CSS Theme Module (“primefaces-themes” separate Maven module).
b. Backend (Application Core)
• Spring Boot Launcher (SiamoisApplication).
• Web Config & Security (WebConfig, WebSecurityConfig, JsfConfig, OpenApiConfig).
• REST APIs (infrastructure.api).
• Event System (domain.events publisher and listeners).
• Service Layer (domain.services) implementing business use-cases.
• Domain Model (domain.models) — Entities, Value Objects, Exceptions.
• Data Access (infrastructure.database.repositories via Spring Data JPA).
• Database Initialization & Migrations (infrastructure.database.initializer + Liquibase changelogs).
• File Storage (infrastructure.files.DocumentStorage).
• Utilities & Builders (fr.siamois.utils).
c. External Systems
• PostgreSQL database.
• External Thesaurus API & Concept API (infrastructure.api/ThesaurusApi, ConceptApi).
• ARK/PURL resolution service (through ArkService, ArkRedirectionService).
Interactions and Data Flows
1. Browser → JSF pages → Managed Beans → Service Layer
2. Service Layer → Repositories → PostgreSQL
3. Service Layer → Event Publishers → Domain Listeners (e.g., ApplicationReadyListener)
4. Service Layer → External API Clients → Remote Thesaurus/ARK services
5. File upload/download through DocumentStorage → Filesystem or blob store
6. Liquibase runs on application start (DatabaseInitializer)
Architectural Patterns & Principles
• Layered Architecture (Presentation → Controller → Service → Repository → Database)
• Domain-Driven Design (rich domain.models, domain.services)
• Event-Driven (domain.events publisher/listener)
• Dependency Injection (Spring)
• Configuration via YAML (application.yaml) and Java @Configuration classes
• Build & CI via Maven and GitHub Actions (maven.yml)