Module Compatibility Matrix
This matrix shows common pairings and expectations. Use it as a quick wiring checklist.
| Module | Requires | Enhances | Notes |
|---|---|---|---|
@quik/core | - | All | Base services and feature defaults. |
@quik/bootstrap | @quik/core | All | Required to assemble modules. |
@quik/http | @quik/core | @quik/openapi, @quik/telemetry, @quik/authorization | Route definitions and decorators. |
@quik/http-express | @quik/http | @quik/openapi, @quik/telemetry | Express adapter for HTTP. |
@quik/openapi | @quik/http | - | Spec generation for HTTP routes. |
@quik/authorization | @quik/http | @quik/passport | Guards and authorization decorators. |
@quik/passport | @quik/authorization | - | Strategy integration. |
@quik/database | @quik/core | @quik/entity | DB connections and repositories. |
@quik/entity | @quik/database | - | Entities, validation, pagination. |
@quik/storage | @quik/core | @quik/storage-express | Storage engines. |
@quik/storage-express | @quik/storage | - | Uploads and middleware. |
@quik/telemetry | @quik/core | @quik/http, @quik/scheduler | Tracing and spans. |
@quik/logging | @quik/core | All | Logger configuration. |
@quik/healthcheck | @quik/core | @quik/http | Health checks and endpoints. |
@quik/scheduler | @quik/core | @quik/telemetry, @quik/logging | Cron and task scheduling. |
@quik/templates | @quik/core | @quik/pdf | Template registry. |
@quik/pdf | @quik/templates | - | PDF templates and rendering. |
@quik/i18n | @quik/core | @quik/http | Locale resolution. |
@quik/metadata | @quik/core | All | Metadata registry. |
@quik/services | @quik/core | All | Shared service contracts. |
@quik/communication | @quik/core | @quik/telemetry | Messaging pipeline. |
@quik/cli | - | All | CLI utilities for local dev. |