# digitalservicebund/ris-backend-service architecture

> Architecture diagram of the GitHub repository digitalservicebund/ris-backend-service, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/digitalservicebund/ris-backend-service
- Repository: https://github.com/digitalservicebund/ris-backend-service

## Overview

##### Main Components

a. Client Layer:
- Vue.js 3 Frontend Application
- Components for document management, case law, and periodical evaluation
- Text editor with specialized features
- Authentication interface

b. API Layer:
- Spring MVC REST API endpoints
- Authentication/Authorization controllers
- Documentation unit controllers
- File handling controllers

c. Service Layer:
- Documentation unit services
- Conversion services (DOCX)
- Authentication services
- Mail services
- XML export services

d. Data Layer:
- PostgreSQL database
- Document storage (S3)
- Lookup tables
- Migration systems

e. External Systems:
- Keycloak (Authentication)
- ArgoCD (Deployment)
- Monitoring (Grafana/Prometheus)
- Mail services

##### Relationships and Data Flow

- User requests flowing from frontend through API endpoints
- Authentication flows through Keycloak
- Document processing flows (upload → conversion → storage)
- Database interactions
- Export processes to XML
- Monitoring data collection

##### Important Architectural Patterns to Highlight

- Ports and Adapters architecture (shown in backend structure)
- Domain-driven design elements
- Microservices-like separation of concerns
- Event-driven components for document processing
- Layered frontend architecture

##### Specific Implementation Details

Technical labels for:
- Vue 3 + Vite (Frontend)
- Spring Boot (Backend)
- PostgreSQL (Database)
- S3 (Document Storage)
- Docker containers
- Kubernetes deployment

##### Security Layer

Highlight:
- OIDC authentication flow
- API security measures
- CSRF protection
- Role-based access control

##### Monitoring and Operations

Show:
- Grafana dashboards
- Prometheus metrics collection
- Health check endpoints
- Logging flows

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef frontend fill:#3498db,color:white
    classDef api fill:#2ecc71,color:white
    classDef service fill:#27ae60,color:white
    classDef data fill:#f1c40f,color:black
    classDef external fill:#95a5a6,color:white
    classDef security fill:#e74c3c,color:white
    classDef monitoring fill:#9b59b6,color:white

    %% Frontend Layer
    subgraph Frontend
        VueApp["Vue.js 3 Frontend"]:::frontend
        Components["UI Components"]:::frontend
        Routes["Routes"]:::frontend
        FrontendServices["Frontend Services"]:::frontend
    end

    %% API Layer
    subgraph API
        DocController["Documentation Unit Controller"]:::api
        AuthController["Auth Controller"]:::api
        CsrfController["CSRF Controller"]:::api
    end

    %% Service Layer
    subgraph Services
        DocService["Documentation Unit Service"]:::service
        ConvService["Converter Service"]:::service
        AuthService["Auth Service"]:::service
        MailService["Mail Service"]:::service
        XmlService["XML Export Service"]:::service
        DocxService["DOCX Converter"]:::service
        S3Service["S3 Attachment Service"]:::service
    end

    %% Data Layer
    subgraph Data
        PostgreSQL[(PostgreSQL)]:::data
        S3[(S3 Storage)]:::data
        JPA["JPA Repositories"]:::data
        Migrations["DB Migrations"]:::data
    end

    %% External Systems
    subgraph External
        Keycloak["Keycloak"]:::external
        ArgoCD["ArgoCD"]:::external
        MailServer["Mail Server"]:::external
    end

    %% Monitoring
    subgraph Monitoring
        Grafana["Grafana"]:::monitoring
        Prometheus["Prometheus"]:::monitoring
    end

    %% Security
    SecurityConfig["Security Config"]:::security
    KeycloakService["Keycloak Service"]:::security

    %% Relationships
    VueApp --> Components
    VueApp --> Routes
    VueApp --> FrontendServices
    FrontendServices --> DocController
    FrontendServices --> AuthController
    FrontendServices --> CsrfController

    DocController --> DocService
    AuthController --> AuthService
    AuthController --> KeycloakService
    
    DocService --> ConvService
    DocService --> XmlService
    DocService --> S3Service
    DocService --> JPA
    
    ConvService --> DocxService
    AuthService --> Keycloak
    MailService --> MailServer
    
    JPA --> PostgreSQL
    S3Service --> S3
    
    Prometheus --> Grafana
    
    %% Click events
    click VueApp "https://github.com/digitalservicebund/ris-backend-service/tree/main/frontend/src/"
    click Components "https://github.com/digitalservicebund/ris-backend-service/tree/main/frontend/src/components/"
    click Routes "https://github.com/digitalservicebund/ris-backend-service/tree/main/frontend/src/routes/"
    click FrontendServices "https://github.com/digitalservicebund/ris-backend-service/tree/main/frontend/src/services/"
    click DocController "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/DocumentationUnitController.java"
    click AuthController "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/AuthController.java"
    click CsrfController "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/CsrfController.java"
    click DocService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/domain/DocumentationUnitService.java"
    click ConvService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/domain/ConverterService.java"
    click AuthService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/domain/AuthService.java"
    click MailService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/domain/MailService.java"
    click JPA "https://github.com/digitalservicebund/ris-backend-service/tree/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/database/jpa/"
    click Migrations "https://github.com/digitalservicebund/ris-backend-service/tree/main/backend/src/main/resources/db-scripts/migration/"
    click S3Service "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/S3AttachmentService.java"
    click DocxService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/DocxConverterService.java"
    click SecurityConfig "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/config/SecurityConfig.java"
    click KeycloakService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/KeycloakUserService.java"
    click Grafana "https://github.com/digitalservicebund/ris-backend-service/tree/main/backend/monitoring/grafana/"
    click Prometheus "https://github.com/digitalservicebund/ris-backend-service/tree/main/backend/monitoring/prometheus/"
    click XmlService "https://github.com/digitalservicebund/ris-backend-service/blob/main/backend/src/main/java/de/bund/digitalservice/ris/caselaw/adapter/JurisXmlExporterWrapper.java"
```
