Skip to main content

Project Structure Checklist

Use this checklist when creating a new Quik service.

Required​

  • src/app/AppModule.ts registers modules in dependency order.
  • src/main.ts starts the bootstrap app.
  • src/config/index.ts exposes getConfig() values.
  • src/http/routes/ contains controller classes.
  • src/modules/<domain>/models for entities.
  • src/modules/<domain>/services for business logic.
  • Tests for each route and service.
  • src/modules/<domain>/dto for request/response payloads.
  • src/modules/<domain>/errors for domain-specific errors.
  • src/modules/<domain>/validators for validation rules.

Optional​

  • Scheduler jobs in src/modules/<domain>/schedulers.
  • Telemetry spans around background tasks and long requests.
  • Healthchecks for external dependencies.