How digitalservicebund/ris-norms works
Main Components and Architecture
The system follows a hexagonal architecture (as mentioned in ADR 0005) with these key components:
a. Frontend Layer:
• Vue.js-based web application
• Components for law editing, metadata management, and document viewing
• Client-side services for API communication
• End-to-end testing with Playwright
b. Backend Layer:
• Java 21 Spring Boot application
• Hexagonal architecture with:
• Input ports (REST API controllers)
• Application core (services and domain logic)
• Output ports (database and S3 storage)
• XML processing capabilities for LegalDocML.de format
c. Data Storage:
• PostgreSQL database
• S3 storage for document management
• Schema validation system for LegalDocML.de
Integration Points
• REST API communication between frontend and backend
• Database interactions for norm storage
• S3 bucket integration for document storage
• Monitoring with Prometheus and Grafana
User Interface Layer (Top)
• Main views (amending-law, affected-documents, etc.)
• Client-side services
API Gateway Layer
• REST API endpoints
• Security and session management
• Validation components
Application Core (Middle)
• Hexagonal architecture
• Domain services and use cases
• XML processing components
Persistence Layer (Bottom)
• Database connections
• S3 storage integration
• Document management system
Use these visual elements:
• Red lines for security boundaries
• Security boundaries
• Integration points
Key Architectural Patterns to Highlight:
Monitoring and observability
• Clear separation of concerns
• Security boundaries
• Data flow patterns
• Integration points
• Scalability considerations
Remember to include:
External system interfaces
This will provide a comprehensive view of the RIS Norms system while maintaining clarity and usefulness for the principal software engineer.