How dhontecillas/hfw works
Main Components
a) Core Framework Components:
• Web Server Layer (Gin-Gonic)
• Authentication System
• Configuration Management
• Database Integrations (PostgreSQL & Redis)
• Observability Stack
• Mailer System
• Internationalization (i18n)
• Notification System
b) External Services:
• PostgreSQL Database
• Redis Cache
• Email Services (SendGrid, Mailtrap, etc.)
• Observability Services (Prometheus, Grafana, Tempo)
┌─ Application Layer ─────────────────────────────────────┐
• Web Apps / API Clients │
• ┘
• ↓
┌─ Framework Layer ──────────────────────────────────────┐
• ┌─ Web Layer ─┐ ┌─ Auth Layer ┐ ┌─ API Layer ─┐ │
• Gin-Gonic │ │ Users │ │ Token API │ │
• Sessions │ │ CSRF │ │ REST APIs │ │
• ┘ └─────────────┘ └────────────┘ │
• ┌─ Core Services ────────────────────────────────────┐│
• Config │ Mailer │ i18n │ Notifications │ Bundler ││
• ┘│
• ┘
• ↓
┌─ Observability Layer ────────────────────────────────┐
• ┌─────────┐ ┌──────────┐ ┌────────┐ ┌─────────┐ │
• Metrics │ │ Logging │ │ Traces │ │ Sentry │ │
• ┘ └──────────┘ └────────┘ └─────────┘ │
• ┘
• ↓
┌─ Storage Layer ───────────────────────────────────────┐
• PostgreSQL (Primary Storage) Redis (Cache/Sessions) │
• ┘
Important Details
a) Component Interactions:
• How the web layer interfaces with auth and API layers
• Data flow between storage systems and services
• Demonstrate how observability cuts across all layers
b) Key Features:
• ULID/UUID handling for IDs
• Email notification flow
• Session management
• Configuration management
• Internationalization support
Specific Implementation Notes
• Relationship between pkg/ginfw and the web server layer
• How pkg/obs connects to various observability tools
• Demonstrate the mailer system's multiple implementations
• How the bundler package fits into the deployment process
External Service Integration
• Email providers (SendGrid, Mailtrap, etc.)
• Observability tools (Prometheus, Grafana)
• Database systems (PostgreSQL, Redis)
Notes for Implementation
• Version compatibility information
• Configuration requirements
• Security boundaries