How edgelesspe/nlm works
Main Components
a. Frontend (Vue 3 + TypeScript SPA)
b. Backend Web Server (Go REST API)
c. Database (PostgreSQL with JSONB fields)
d. External Storage & Download Services (rclone uploader, nginx downloader)
e. External Integrations (GitHub API, Webhooks, Bot messaging service)
f. Scheduler / Trigger subsystem (Cron jobs, incoming webhooks)
Logical Layers in the Backend
• API Layer (HTTP handlers in backend/handler)
• Middleware Layer (backend/middleware)
• Service Layer (backend/service)
• Pipeline Orchestration (backend/pipeline)
• Domain & Model (backend/domain, backend/model)
• Persistence Layer (backend/db)
• Driver Layer (backend/driver) for external I/O
• Utility Layer (backend/utils) for common helpers
• VO Layer (backend/vo) for transport/value objects
Interactions and Data Flows
a. Frontend → HTTP(S) requests → Backend API
b. Middleware authenticates/validates → Handlers dispatch to Services
c. Service logic may:
• Read/write from Database
• Invoke Drivers (download via nginx, upload via rclone)
• Trigger or advance Pipelines (ept, bot, QA, mirror, storage)
• Call external APIs (GitHub via backend/utils/github.go)
• Emit webhooks or bot notifications (service/bot.go, handler/webhook.go)
d. Scheduler (Cron) triggers scheduled pipelines (trigger/cron.go)
e. Incoming Webhooks hit trigger/webhook.go → injected into pipeline
External Components & Data Stores
• PostgreSQL: tables for NEP, EPT, pipelines, storage records
• Nginx Server: serves download URLs for mirrored packages
• Rclone‐backed Storage: pushes artifacts to S3/GCS/etc.
• GitHub API: fetch release metadata, validate packages
• Messaging Bot: Telegram/Slack notifications for pipeline results
Architectural Patterns & Principles
• Layered Architecture: clear separation between API, service, domain, persistence
• Dependency Injection: config/env loaded in backend/config/env.go
• Modular Pipelines: each pipeline type in backend/pipeline
• Trigger‐Driven Workflows: cron + webhook subsystems feed into pipelines
• VO & Model segregation: transport vs. DB schema