How v-par23/incident-board-api works
Incident Board is a lightweight Node.js API for managing service incidents and powering an on-call summary. An HTTP client reaches the server, whose app handler routes requests to incident operations or the service-report logic; those services read and update an in-memory store, and the handler returns JSON. The documented workflow covers incident listing, creation, retrieval, updates and status transitions, plus per-service summaries. Demo data initializes the store at startup. Source excerpts establish the main calls; endpoint behavior and the client-facing workflow are also documented in the README.
Main entry points: app.ts Request Handler · server.ts HTTP Server · incidentService.ts Incident Operations · memoryStore.ts Memory Store
Components 10
HTTP API
- HTTP Server
src/server.ts - Request Handler
src/app.ts - Path Router
src/router.ts - API Errors
src/errors.ts
Incident Domain
- Incident Operations
src/services/incidentService.ts - Domain Types
src/constants.ts
On-call Reporting
- Service Summary
src/services/serviceReportService.ts
Persistence
- Memory Store
src/store/memoryStore.ts - Demo Data
src/data/seed.ts
Other components
- HTTP Client
Connections 15
- HTTP Client → HTTP Server: sends HTTP requests
README.md - HTTP Server → Request Handler: starts handler
src/server.ts - HTTP Server → Memory Store: initializes store
src/server.ts - HTTP Server → Demo Data: loads demo data
src/server.ts - Request Handler → Path Router: matches routes
src/app.ts - Request Handler → Incident Operations: dispatches incident requests
src/app.ts - Request Handler → Service Summary: dispatches summary requests
src/app.ts - Request Handler → API Errors: handles API errors
src/app.ts - Request Handler → HTTP Client: returns JSON
src/app.ts - Incident Operations → Memory Store: reads and writes
src/services/incidentService.ts - Incident Operations → Domain Types: uses domain types
src/services/incidentService.ts - Incident Operations → API Errors: throws validation errors
src/services/incidentService.ts - Service Summary → Memory Store: reads service incidents
src/services/serviceReportService.ts - Service Summary → API Errors: throws not found
src/services/serviceReportService.ts - Memory Store → Domain Types: stores domain records
src/store/memoryStore.ts