How missaelhrz512/noc works
Project type and purpose
• This is a backend service built in TypeScript following a clean-architecture (onion/hexagonal) style.
• It exposes two “presentation” entry points:
• HTTP API (src/presentation/server.ts)
• Cron jobs (src/presentation/cron/cron-service.ts)
• Business logic lives in the Domain layer (src/Domain/use-cases/...).
File structure
• Top level
• package.json, tsconfig.json, app.ts (composition root), readme.md
• src/Domain/use-cases/checks/check-service.ts
• Contains core “check” use-case implementation
• src/presentation
• server.ts → HTTP routes/controllers
• cron/cron-service.ts → scheduled tasks
Key insights from the README
• “presentation” = layer closest to the user/triggers
• “Domain” = business-use-cases
Main components
a. Presentation Layer
• HTTP Server (Express/Fastify in server.ts)
• Cron Scheduler (cron-service.ts)
b. Application Composition (app.ts)
• Wires presentation → domain
c. Domain Layer
• CheckService use case
d. (Optional) External dependencies
• Database or external APIs if any (not shown in tree)
Relationships & data flows
• HTTP request → server.ts controller → invokes CheckService → returns response
• Scheduler trigger → cron-service.ts → invokes CheckService → handles result
• app.ts boots the server, registers routes, and schedules cron jobs
Architectural patterns & principles
• Clean/Onion architecture: clear separation between Presentation and Domain
• Dependency Inversion: Presentation depends on Domain interfaces/use-cases
• Single Responsibility: each module has one purpose