How umputun/remark42 works
Main Components Overview
a) Backend (Go-based):
• Core API Service
• Authentication System
• Storage Engine
• Notification Service
• Migration Tools
• Admin Interface
b) Frontend (JavaScript/TypeScript):
• Comment Widget
• Admin UI
• Authentication UI
• Markdown Editor
• Real-time Updates
c) Data Storage:
• Embedded Database
• File Storage (for images)
• Backup System
Key Relationships to Highlight
a) External Integrations:
• Social Login Providers (Google, Facebook, GitHub, etc.)
• Notification Services (Email, Telegram, Slack, Webhook)
• RSS Feeds
• Image Upload/Storage
b) Internal Communications:
• Frontend Widget ↔ Backend API
• Authentication Flow
• Storage Operations
• Notification Pipeline
Architectural Patterns
Architectural decisions:
• Microservices-like structure (separate frontend/backend)
• REST API communication
• Event-driven notification system
• Embedded storage architecture
• Multi-site support
Detailed Component Breakdown
┌─ API Layer
• Public API
• Private API
• Admin API
┌─ Auth Service
• Social Providers
• Email Auth
• Anonymous Access
┌─ Storage Engine
• Comment Store
• User Store
• Image Store
┌─ Notification System
• Email Notifications
• Telegram Bot
• Slack Integration
• Webhooks
┌─ Widget
• Comment Thread
• Auth UI
• Markdown Editor
• Voting System
┌─ Admin Interface
• Moderation Tools
• User Management
• Site Settings
Additional Elements
Supporting elements:
• Version/Environment information
• Security boundaries
• Backup/Restore flows
• Data migration paths
Technical Details to Note
Annotations for:
• Docker container boundaries
• API endpoints
• Authentication flows
• Data persistence paths
• Backup/restore processes
Remember to highlight the system's unique features like embedded database usage, stateless design, and the ability to run as a single container or self-contained executable.