How marvinhill/storytellr works
Main Components
a. Frontend Layer (Angular Web Application):
• Sub-components:
• User Interface Components (book-detail, editor, library, etc.)
• Services Layer (book.service, chapter.service, etc.)
• Authentication Integration
b. Authentication Layer (Keycloak):
• Include:
• User Management
• OAuth2/OpenID Connect
• Custom Theme (Keywind)
c. Backend Layer (Spring Boot API):
• Sub-components:
• Controllers (REST endpoints)
• Services Layer
• Repository Layer
• Security Configuration
d. Data Storage Layer:
• Main Database (for books, chapters, etc.)
• Keycloak Database
• Public Data Storage (for covers and media)
e. Infrastructure Layer:
• Nginx Proxy
• Docker Containers
• Public Data Server
Connection Flows
• User → Nginx Proxy
• Nginx Proxy → Angular Frontend
• Angular Frontend ↔ Keycloak (authentication flow)
• Angular Frontend ↔ Spring Boot API (protected endpoints)
• Spring Boot API ↔ Databases
• Spring Boot API ↔ Keycloak (token validation)
Additional Details
Annotations for:
• Security boundaries
• API endpoints grouping (v1)
• Data flow directions
• Authentication flows
• Docker container boundaries
Component Details
• Technologies used (Angular, Spring Boot, Keycloak)
• Key features (e.g., Editor.js integration, polling system)
• Communication protocols (REST, OAuth2)
Infrastructure Notes
Notes regarding:
• Docker composition
• Development vs Production profiles
• Environment configurations
• Proxy settings