Skip to content

README.md

Latest commit

 

History

History
77 lines (52 loc) · 4.61 KB

README.md

File metadata and controls

77 lines (52 loc) · 4.61 KB

Design Hub — Phase Gate 2 & Technical Design Suite

Bilingual Navigation: English (this document) · Versión en Español Up: Repository Portal

Goal and Objectives

Goal: translate approved business requirements into immutable technical contracts before any code is written (BR-002), and host the Tracker's own application design suite.

Objectives:

  • Define the Design domain model (TechnicalBlueprint, Contract, ADR, DataSchema).
  • Specify the Tracker application internals: NestJS backend, React frontend, PostgreSQL data design.
  • Document the gate engine, contingency engine, and external integrations (UMS, Core).

Domain Model (DDD)

Domain Model (DDD)
Document Description Purpose Type
Consolidated Domain Model & E/R The single consolidated DDD design: proposed conceptual model, the 9 bounded contexts, aggregates, value objects, and the E/R design across the 10 schemas Single source for the proposed domain design — per-context tactical detail is navigated from here DDD

Application Architecture

Application Architecture
Document Description Purpose Type
Target Architecture (TAD) Master technical architecture: bounded contexts, domain model, CQRS, layers, deployment Single reference to understand how the whole Tracker application is built Architecture
NestJS Backend Design Backend blueprint: module layout, CQRS buses, repositories, guards, middleware Guide backend developers implementing any bounded context Backend
React Frontend Design Frontend blueprint: Module Federation shell + 7 remotes, Zustand/TanStack state, routing Guide frontend developers building or extending a microfrontend Frontend
PostgreSQL Data Design Physical data design: 10 schemas, full DDL, RLS policies, indexes, concurrency control Implement or migrate the database exactly as approved Data

Gate and Contingency Engines

Gate and Contingency Engines
Document Description Purpose Type
Phase Gate Design Gate evaluation engine: criteria model, requirement checklists, exception handling Implement how gates evaluate, block, and authorize phase transitions Architecture
Re-Do Flow Design Release contingency engine: triggers, state model, recalculation algorithm, human authorization Implement the automatic contingency recalculation when a release is blocked Architecture

External Integrations

External Integrations
Document Description Purpose Type
UMS Authentication Integration Identity integration with UMS SaaS: JWT validation, JWKS rotation, auth guards Wire authentication correctly — the Tracker manages no users itself Integration
UMS Authorization Graph Design Translation of the UMS authorization graph into Tracker permissions and role hierarchy Implement fail-closed authorization on every surface (Web/CLI/MCP) Integration
Core Integration Design Consumption of Evolith Core rulesets, artifact schemas, and taxonomy, with caching strategy Keep the Tracker conformant with the immutable upstream baseline (BR-005) Integration
Agent Assignment API Contract for assigning agents to phase work: endpoints, modes, errors, events Implement agent orchestration (manual/automated) with REST/CLI/MCP parity (BR-008) API
Artifact & Evidence Design Artifact system design: definitions, instances, and evidence records per gate Implement the evidence chain that proves every gate decision Architecture

Planning

Planning
Document Description Purpose Type
Implementation Roadmap Implementation plan: 8 phases, effort estimates, dependencies, risks Sequence the construction work and track delivery risk Planning