How joshmerlino/insomnia-viewer works
Main Components
a. Frontend Layer (Web Application)
• React Components (from web/ts/components/)
• Static Assets (from web/static/)
• Styles (LESS files from web/styles/)
• Runtime Utilities
b. Backend Layer (Server)
• Express.js Server (src/server.ts)
• Middleware Stack (src/middleware/)
• Runtime Handlers (src/runtime/)
Component Relationships
• Client Browser → Frontend Layer
• Frontend Layer → Backend Layer (API requests)
• Backend Layer → Documentation Storage/Processing
• Middleware Chain Flow (showing the sequence of middleware components)
Specific Implementation Details
Frontend Section:
┌─────────────────────────────────────┐
• Frontend (React Application) │
• ┌─────────────┐ ┌────────────────┐ │
• Components │ │ Runtime Utils │ │
• App │ │ - ErrorBoundary │ │
• Docs │ │ - Offline │ │
• Search │ │ Installation │ │
• ┘ └────────────────┘ │
• ┌─────────────┐ │
• Styles │ │
• (LESS) │ │
• ┘ │
• ┘
Backend Section:
┌─────────────────────────────────────┐
• Backend (Express.js) │
• ┌─────────────┐ ┌────────────────┐ │
• Middleware │ │ Runtime │ │
• Body │ │ - Docs │ │
• Cookie │ │ - Static │ │
• CORS │ │ │ │
• SSL │ │ │ │
• Gzip │ │ │ │
• ┘ └────────────────┘ │
• ┘
Additional Elements
• Build/Deploy Pipeline:
• Webpack Configuration
• Docker Container
• GitHub Actions Workflows
• Blue: Frontend components
• Green: Backend components
• Orange: Build/Deploy tools
• Gray: External services/dependencies
Important Architectural Patterns to Highlight
• Component-based architecture (React)
• Middleware pattern (Express.js)
• Static file serving
• Documentation processing pipeline
Technical Stack Indicators
• TypeScript
• React
• Express.js
• Docker
• Webpack
• LESS
Flow Directions
• User request flow
• Documentation processing flow
• API communication paths
• Build/deployment pipeline
Remember to:
• Use consistent styling
• Version information
• Document all major integration points
• Security boundaries (if applicable)