How foxocorp/foxogram-backend works
Main Components Structure
a) foxogram-api (REST API Service)
• Controllers layer (Authentication, Channels, Messages, Users)
• Interceptors for security and authentication
• PenaltyBucket utility for rate limiting
b) foxogram-gateway (WebSocket Gateway)
• WebSocket configuration
• Event handling system
• Session management
• RabbitMQ listener
c) foxogram-common (Shared Library)
• Shared components like models, DTOs, and services
• Configuration management
• Utility services
External Services Integration
External services with clear connection lines:
• Database (implied by repositories)
• RabbitMQ (message broker)
• MinIO (file storage)
• Email Service
• Metrics (Micrometer)
Data Flow Representation
• Client → API interactions
• Client → WebSocket Gateway interactions
• Inter-service communication via RabbitMQ
• Data persistence flows
• Authentication flows
Detailed Component Breakdown
For each service, show:
• Input/Output DTOs
• Security layers
• Service layers
• Repository layers
• External service integrations
Architectural Patterns to Highlight
• Microservices communication
• Event-driven architecture (RabbitMQ)
• Repository pattern
• MVC pattern in API service
• Interceptor pattern
Remember to:
• Version numbers for major components
• Scalability points
• Security boundaries
• Document all external service dependencies
This will provide a comprehensive view of the Foxogram backend system while maintaining clarity and usefulness for technical discussions and development planning.