How viaacode/hetarchief-proxy works
Main System Components
a) Core Application Layer:
• NestJS Backend Proxy (Main Application)
• Authentication System
• GraphQL Integration (Hasura)
• Elasticsearch Integration
• Redis Cache
• Campaign Monitor Integration
• Zendesk Integration
b) External Services:
• Hasura GraphQL Engine
• Elasticsearch
• Campaign Monitor
• Zendesk
Module Organization
Following main functional modules:
• Auth Module (Authentication/Authorization)
• Users Module
• Content Partners Module
• IE Objects Module (Information Entity Objects)
• Visits Module
• Spaces Module
• Folders Module
• Notifications Module
• Material Requests Module
┌─ Client Applications ─────────────────────┐
• API Gateway Layer ──────────────────────┤
• [NestJS Backend Proxy] │
• Service Layer ───────────────────────────┤
• [Auth] [Users] [Content] [IE Objects] │
• [Visits] [Spaces] [Folders] [Notifications]│
• Data Access Layer ────────────────────────┤
• [Hasura GraphQL] [Elasticsearch] [Redis] │
• External Services ────────────────────────┤
• [Campaign Monitor] [Zendesk] │
• ┘
Connection Types
• Cache interactions (wavy lines)
Environment Configuration
A separate section showing:
• Environment Variables
• Configuration Management
• Service Endpoints
Specific Implementation Details
Specialized components:
• Campaign Monitor Integration
• Elasticsearch Query Builder
• Notification System
• Material Request Handling
This system design should reflect the NestJS modular architecture while showing how the proxy serves as a middleware between client applications and various backend services, with special attention to the authentication and authorization flows that are crucial for this archival system.