How rjbrown57/cartographer works
Main Components
a. Frontend Layer:
• Web UI (HTML/JS) located in /web directory
• Static assets and templates
• Client-side JavaScript interactions
b. Backend Layer:
• GRPC Server (main application server)
• In-memory Backend Storage
• Configuration Management
• API Endpoints
c. Client Components:
• CLI Client
• GRPC Client implementations
Service Architecture
[Web UI] <-> [GRPC Server] <-> [In-memory Backend]
• ^
[CLI Client]
Data Flow Components
• Configuration Management (/pkg/types/config)
• Data Models (Groups, Tags, Links)
• Backend Storage System
• Template Engine
Specific Implementation Details
• HTTP/Web Server (Gin Framework)
• GRPC Server
• In-memory Backend
• Configuration Manager
b. API Layer (show as interfaces):
• GRPC Protocol Definitions (/proto)
• REST Endpoints
• Backend Interface
c. Data Models (show as entities):
• Groups
• Tags
• Links
Integration Points
Clear integration points for:
• Kubernetes deployment (via Helm)
• Configuration loading
• Client interactions (CLI and Web)
┌─────────────────────────────────────────────┐
• Client Layer │
• (Web UI / CLI Client / GRPC Client) │
• ┤
• Service Layer │
• (GRPC Server / HTTP Server / Config) │
• ┤
• Storage Layer │
• (In-memory Backend) │
• ┘
Important Details to Capture
• GRPC service definitions
• Configuration flow
• Authentication points (TODO item)
• Data model relationships
• API versioning (v1 noted in structure)
Deployment Context
A separate section showing:
• Kubernetes deployment topology
• Helm chart structure
• Configuration mounting
• Line styles
• Version information
• Configuration sources
This will provide a comprehensive view of Cartographer's architecture while maintaining clarity about its core purpose of managing and sharing URLs and environment information.