Files
clean-architecture-frontend…/README.md
T
DongHyeonka 16202fd48d fix(docs): 현재 계약 문서의 경로·명령·게이트 ID를 검사한다 (14-05)
문제: docs/README.md 1절은 현재 계약 문서를 "게이트가 검사한다"고
소개하지만 verify:documentation은 route ID 목록, 빌드 변수, src 구조,
그리고 repo 밖 2026-07-18 diagram 리뷰 기록의 두 사본끼리의 일치만 본다.
diagram 검사는 구조가 바뀌어도 늘 통과한다. 그래서 이미 drift가 쌓였다.
README 라우트 표에 /examples/platform이 없고 언어 선택기를 적지 않는다.
design-tokens.md는 theme.css를 SSOT라고 하고 3계층 토큰과
check:design-system 규칙 4개를 모른다. compatibility.md의 줄 번호가
어긋났다. ledger는 옮겨진 tests/unit/ci-artifact-contract.test.ts를
설명 없이 가리킨다. 또 README와 수동 접근성 체크리스트가 route ID를
모두 나열해야 해서, 기능을 하나 더할 때마다 템플릿 소유 문서 두 개를
고쳐야 한다(다운스트림 동기화 충돌 지점).

고른 방법: 리뷰 5.3의 (b)+(d)와 오케스트레이터 결정 3.
- route ID 나열을 지운다. verify:documentation은 설치된 라우트마다
  artifacts/tests/a11y-manual/<ROUTE_ID>.md가 있는지 보고, 없으면 route
  ID를 적고 실패한다. README·체크리스트에는 목록 대신 정본 위치
  (ROUTE_REGISTRY, 기록 폴더)를 적는다. README 라우트 표도 같은 이유로
  starter-experience.md처럼 ROUTE_REGISTRY와 /examples/platform을
  가리키게 바꾼다.
- docs/README.md와 그 1절이 링크한 문서(폴더 링크는 안의 .md 전부)에
  적힌 repo 경로·링크·package script·FE-GATE ID가 있는지 검사한다.
  문서 목록은 1절 링크에서 읽으므로 손으로 둔 목록이 없다. 문서는
  작업 폴더에서 읽고, 존재 여부·script·게이트는 14-03 검사처럼 이 repo
  기준으로 본다. 예외는 셋이다: git이 무시하는 생성 산출물(.gitignore에서
  읽는다), README "Files you can delete after copying"의 이력 중 지워진
  것, 아직 없는 src/adapters/web-worker(규칙이 자리를 잡아 둠). 은퇴한
  FE-GATE-016은 RETIRED_GATE_IDS에서 읽는다. CHANGELOG는 지난 상태를
  적는 문서라 뺀다.
- compatibility.md의 줄 번호를 심볼 이름으로 바꾸고, design-tokens.md에
  3계층 파일과 UI-01·02·03·05 규칙을 적고, ledger의 옮겨진 테스트
  경로를 현재 위치로 고치고 그 사실을 머리에 적는다.
- diagram 검사의 실패 이름을 "2026-07-18 diagram review copy …"로 바꾸고
  ci-quality-gates.md에 원본이 repo 밖이라 늘 통과한다고 적는다.
- documentation-review.json에 documentReferences를 더한다. routeScope는
  모양을 유지하고 기록 폴더 한 항목으로 쓴다.
버린 대안: 라우트 표를 route registry와 대조 — 기능마다 README를
고치게 되어 결정 3의 이유와 충돌한다. 문서 전체 내용 검사(c) — 자연어
주장은 기계로 검사할 수 없다. 생성 산출물 제외를 접두어 목록으로 —
artifacts/ 안의 커밋된 기록까지 빠지고 목록이 따로 낡는다. git
check-ignore 호출 — git이 없는 복사본에서 모든 생성 경로가 실패한다.

위험·한계:
- 경로는 백틱 안의 "최상위 항목/…" 또는 "문서 옆 항목/…" 꼴과 마크다운
  링크만 잡는다. 슬래시 없는 파일 이름, 자리표시자(<id>, *, {…})가 든
  경로, 심볼 이름이 맞는지는 보지 않는다.
- script는 "corepack pnpm x", "`pnpm x`", 그리고 기존 script 접두어로
  시작하는 "`접두:이름`"만 본다.
- 다운스트림 영향: 참조 기능을 지운 복사본은 그 파일을 가리키는 현재
  계약 문서(README, compatibility.md, starter-experience.md,
  manual-checklist.md)를 고쳐야 이 게이트를 통과한다. 이력 폴더를 지운
  복사본은 그대로 통과한다.
- 수동 기록 파일의 존재는 FE-GATE-009(review:a11y-manual --format-only)도
  본다. 이 검사는 문서 목록 대신 같은 사실을 문서 게이트에서 보는 것이다.
- CHANGELOG.md:11의 해시 문장(리뷰 (마))은 이 커밋에서 고치지 않는다.

검증:
- RED: 새 테스트를 기준(61baf96) 스크립트에 돌리면 14개 중 9개 실패.
  기록 파일을 지워도 통과했고, README·체크리스트에서 route ID를 지우면
  "failed: route scope"로 실패했고, 경로·script·게이트 ID 변이는 모두
  통과했다.
- GREEN: node scripts/verify-documentation-readiness.ts -> PASS_SCOPED.
  tests/unit/documentation-readiness.test.ts 14개 통과. 고치기 전 문서에
  돌리면 ledger의 옮겨진 테스트 경로 두 개를 잡았다.
- 변이: src/contracts/routes.ts에 라우트를 하나 더하면 README·체크리스트를
  고치지 않아도 "artifacts/tests/a11y-manual/ has no record for route IDs:
  EXAMPLES_DRIFT"로만 실패하고, 기록 파일을 더하면 통과했다(되돌림).
- 회귀: tests/unit 전체(fixture-node-modules 제외) 173파일 2505개 통과.
  deletable-history-documents 통과. tsc(node, test) 통과. 바꾼 ts 파일
  eslint 통과. check-ci-contract, generate-artifact-schemas --check,
  generate-ci-workflow --check, check-adapter-inventory 통과.
  check-remediation-ledger는 기준 커밋과 같은 4건으로 실패(게이트 밖,
  이번 변경과 무관).
- 미실행: check:architecture(pnpm 필요, worktree에서 금지).
2026-11-03 01:13:16 +09:00

21 KiB

Clean Architecture Frontend Template

A React/Vite reference implementation where architecture boundaries, integration behavior, release coherence, accessibility, performance, and operations are executable contracts rather than conventions.

Start locally

Requirements: the exact Node.js version in .nvmrc (currently 24.14.0) and Corepack. The repository pins pnpm in package.json.

Product source, tests, build/quality scripts, and supported tool configuration are TypeScript/TSX. allowJs is disabled. Node-side .ts scripts run directly on the pinned Node 24 runtime and are checked with NodeNext resolution plus erasable-syntax enforcement. Project-owned executable source contains no JavaScript-family files; negative architecture, security, and type-compatibility fixtures are TypeScript/TSX as well.

corepack pnpm install --frozen-lockfile
corepack pnpm dev

Runtime configuration

Runtime-public settings are validated against one schema before the product tree mounts (runtimeConfigV2ArtifactSchema in src/contracts/release-artifacts.ts). Client secrets are forbidden.

The source of truth is config/runtime/<profile>.json, one file per environment: local, development, staging, production. corepack pnpm build writes dist/config.json from the selected profile (scripts/generate-runtime-config.ts). public/config.json is only the local profile for corepack pnpm dev; the build replaces it, so settings put there never reach a deployment. Keep it equal to config/runtime/local.json plus BUILD_ID: local-build and RELEASE_ID: local-release; tests/unit/deployment-admission.test.ts fails when the two differ.

Build and deploy variables, lowest precedence first:

Variable Sets Default
APP_PROFILE which config/runtime/<profile>.json is used local; an empty value fails the build
RUNTIME_API_BASE_URL API_BASE_URL, overriding the profile; the CI workflow cannot pass it (see below) the profile value
RUNTIME_TELEMETRY_ENDPOINT TELEMETRY_ENDPOINT, overriding the profile; the CI workflow cannot pass it (see below) the profile value
VITE_BUILD_ID BUILD_ID in the runtime config and the release manifest local-build
RELEASE_ID RELEASE_ID in the runtime config and the release manifest local-release
RELEASE_TARGET the environment FE-GATE-027 admits the build to; must equal APP_PROFILE none; admission refuses without it

verify:documentation fails if this table stops naming a variable the build or admission reads (scripts/verify-documentation-readiness.ts).

Only the two RUNTIME_* values can differ from the reviewed profile. Anything else changes by editing the profile file. Staging and production reject demo auth, non-HTTPS endpoints and the names reserved for examples and tests (example.com, example.net, example.org and their subdomains, .example, .invalid, .test). The shipped staging and production profiles use *.example.com, so admission refuses them until a project sets its own endpoints.

In CI the only way to set the endpoints is to commit them to config/runtime/<profile>.json. The CI contract binds just APP_PROFILE and RELEASE_TARGET to the build job (scripts/contracts/ci-gates.ts), so a RUNTIME_* repository variable never reaches the build.

A local production build and its admission check:

APP_PROFILE=production \
RUNTIME_API_BASE_URL=<your-api-origin>/ \
RUNTIME_TELEMETRY_ENDPOINT=<your-telemetry-endpoint> \
VITE_BUILD_ID=<unique build id> RELEASE_ID=<unique release id> \
corepack pnpm build
APP_PROFILE=production RELEASE_TARGET=production corepack pnpm check:release-admission

With CI=true the gate runner (corepack pnpm ci:gate) also requires VITE_COMMIT_SHA, SOURCE_DATE_EPOCH and CI_RUNNER_IMAGE before it runs a gate (scripts/lib/build-environment.ts, scripts/run-ci-gate.ts). The CI variable list is in docs/operations/ci-quality-gates.md.

Included starter experience

The default build mounts a domain-neutral application shell with a header, responsive sidebar, route focus management, session integration status, a persistent system / light / dark theme selector, and a language selector.

The route list is ROUTE_REGISTRY (src/features/installed-feature-contracts.ts): the platform routes of src/contracts/routes.ts plus the routes of every installed feature, the removable reference feature included. The platform overview page (/examples/platform) shows the composed list at runtime, so this README keeps no copy of it and adding a feature does not edit it.

AUTH_MODE=demo is credential-free and accepted only in local/development environments. Deployments use AUTH_MODE=external and provide the opaque auth owner described in docs/architecture/starter-experience.md. The client route policy is user experience only; server authorization remains authoritative.

Support scope

Four tiers. The status words on the right are the ones the catalogs and design documents use; the next table maps them.

Tier What it covers Status words
Default In the default build and covered by the merge gates: the application shell and example routes, the REST HTTP executor, TanStack Query server state, Local/Session Storage registries, cross-tab invalidation, runtime config profiles and the release manifest check, AUTH_MODE=external (demo only in local/development), the typed message catalog, and the removable reference feature. dist/ is served by a static host (docs/architecture/static-delivery.md) COMPOSED
Optional (recipe) Not installed. A project copies one of the recipes in config/recipes/frontend-capability-recipes.json and narrows it (docs/architecture/optional-adapter-recipes.md). realtime, offline-indexeddb, service-worker-pwa and file-transfer also ship a tested reference runtime that the default build leaves out RECIPE_AVAILABLE, NOT_INSTALLED, AVAILABLE_NOT_COMPOSED
Experimental Designed and decided, but the runtime is missing or unfinished; finish it before building on it. GraphQL, gRPC-Web, Connect-Web and Protobuf adapters, Range resumable download, IndexedDB query persistence, the local preview decode-safety probe. src/features/local-draft-feature is an architecture sample, not installed DESIGNED_NOT_IMPLEMENTED
Not supported Deliberately not selected, or browsers cannot guarantee it: SSR, app-managed background upload and download, directory selection, persistent file handles, product query persistence, exactly-once delivery between tabs NOT_SELECTED, PLATFORM_LIMITED

The rows come from docs/architecture/browser-data-capability-completion-ledger.md, docs/architecture/client-cache-and-storage.md and docs/architecture/api-contract-schema-mapper-and-server-state.md.

Status word Where it appears Meaning Tier
COMPOSED capability ledger, design documents wired into the default production path Default
INSTALLED a project's own recipe catalog (step 10 of the recipe procedure) the project added the recipe Default, for that project
RECIPE_AVAILABLE recipe catalog status a recipe exists to copy; nothing is installed Optional
NOT_INSTALLED recipe catalog defaultStatus; a src/features/<id>/NOT_INSTALLED marker file not part of the build Optional (recipe) or Experimental (feature)
AVAILABLE_NOT_COMPOSED capability ledger; recipe referenceRuntime.status code and tests exist; the default build leaves it out Optional
DESIGNED_NOT_IMPLEMENTED capability ledger, design documents design approved, runtime missing Experimental
NOT_SELECTED capability ledger, design documents deliberately not chosen Not supported
PLATFORM_LIMITED capability ledger browsers cannot guarantee it; offered only behind a probe and a fallback, if at all Not supported as a guarantee

Gate results (PASS, PASS_SCOPED, UNVERIFIED, FAIL_UNVERIFIED) are verdicts on evidence, not support tiers.

Browsers: the build targets Chrome and Edge 111, Firefox 128, and Safari and iOS 16.4. That is the higher of Vite 8's default JavaScript target (baseline-widely-available; vite.config.ts sets no build.target) and the CSS targets of Tailwind CSS 4. There is no browserslist. The end-to-end suite runs on the desktop Chromium, Firefox and WebKit builds that Playwright 1.62 pins, plus one Chromium phone-size smoke (playwright.config.ts). Older versions inside the target range and real mobile browsers are not tested.

Architecture

This repository is a Frontend Application Foundation: a starter/composition skeleton plus a reusable capability platform. Platform capabilities stay horizontal while product business features use vertical slices.

src/ has nine top-level folders. The descriptions match the table in docs/architecture/layers.md, which also names every import rule:

  • src/bootstrap — the composition root: runtime configuration, concrete adapter construction and the React mount
  • src/apps — deployable apps: each app-module.ts declares an app and its context budget; template-app.ts is the app this build produces
  • src/contexts — bounded contexts: each context-module.ts declares its app, route root and feature budget
  • src/features — removable vertical slices (src/features/<id>/{domain,application,contracts,adapters,presentation}) and the installed-feature catalogs (src/features/*.ts)
  • src/presentation — generic UI and the inbound adapter: routes, layouts, the design system, pages and providers
  • src/adapters — reusable capability runtimes that implement application ports: HTTP, auth, storage, query cache, telemetry, workers and more
  • src/application — generic use cases, ports, policies and view-models
  • src/contracts — shared vocabulary and registries read by several layers, the workers and the build and release scripts
  • src/platform — product-neutral primitives any folder may use: budgets, execution context, resilience, the telemetry pipeline, error envelopes and release coherence

Dependencies point inward. Every folder may also import contracts and platform:

presentation -> application -> contracts -> platform
adapters -----^
bootstrap composes concrete adapters
apps -> contexts -> features   (an app deploys contexts; a context owns features)
feature use case -> feature port <- feature-owned capability binding

Domain code lives inside each feature; there is no top-level domain folder.

See docs/architecture/frontend-application-foundation.md, docs/architecture/overview.md, docs/architecture/layers.md, and docs/architecture/starter-experience.md. The removable vertical slice is under src/features/reference-feature; its domain, application input, HTTP binding, contracts, route runtime, and presentation own their contributions. The central installed catalogs only aggregate selected contributions. The generic starter routes continue to typecheck, test, and build after that feature is removed.

Platform capability review

The starter shell is implemented, but the repository review also records the remaining work required before feature teams can use every declared contract through one end-to-end application path:

These documents distinguish repository defaults from opt-in adapters and project-owned integrations. They are target designs and review findings; a capability is not treated as implemented until its branch acceptance criteria and executable gates pass.

Documentation

docs/README.md sorts the documents into current contracts, target designs and work history.

Files you can delete after copying

These record how the template was built. Nothing in the build or the gates reads them, except the one file noted below (tests/unit/deletable-history-documents.test.ts checks this).

Path Contents
docs/superpowers/ past plans and specs
docs/reviews/ reviews and the review guide. Keep docs/reviews/adapters/INVENTORY.md: check:adapter-inventory (FE-GATE-010) reads it
SPEC.md, tasks/ requirements and task list of the 2026-09-25 review fix round
CLAUDE.md review instructions for the template repository itself; replace it with your own
PRODUCT.md product context of the template itself (users, purpose, principles) for design tools; replace it with your product's

The reference feature is not in this list: deleting its directory alone leaves tests, policy entries and CI scripts behind that fail the gates. scripts/test-sample-removal.ts removes it from a copy of the repository and lists everything that has to go with it (its header comment and SAMPLE_EXTRAS); do the same in your project and run the gates.

Verification

Common local checks:

corepack pnpm lint
corepack pnpm check:types
corepack pnpm check:types:app
corepack pnpm check:types:node
corepack pnpm check:types:test
corepack pnpm check:architecture
corepack pnpm test:all
corepack pnpm test:contract
corepack pnpm test:e2e
corepack pnpm test:a11y
corepack pnpm build
corepack pnpm check:bundle
corepack pnpm test:performance
corepack pnpm verify:compatibility
corepack pnpm verify:release
corepack pnpm check:registries
corepack pnpm drill:runbooks
corepack pnpm check:ci

drill:runbooks stops at the first drill that is not PASS. Without provider evidence every drill ends UNVERIFIED (exit 3), because a drill never reports a check it could not run locally as PASS; see "Runbook jobs" in docs/operations/ci-quality-gates.md.

test:all is the ordinary product-development loop and intentionally excludes host-level CI-runner assurance. Run corepack pnpm test:system only on the compatible Linux assurance host described in docs/testing/taxonomy.md.

check:types는 source, Node scripts/config와 tests를 분리된 TypeScript project로 모두 검사한다. type/architecture/security/registry의 invalid fixture는 config/ci/gates.json에서 “실패해야 통과”하는 negative gate로 실행된다. 도구 호환성 결정은 VD-01에 기록돼 있다.

Application feature input은 module augmentation으로 닫힌 ID와 정확한 input shape를 제공하며, 공통 Result<Value, Failure = AppFailure>는 error registry의 failure kind만 application/presentation 경계를 통과시킨다. Architecture gate는 TypeScript/TSX의 static, dynamic, type import를 별도 정적 그래프로 분석하고 runtime/source 영역의 JavaScript 재유입도 거절한다. 해석되지 않은 import, parse failure, 금지 계층 edge와 순환 의존은 모두 fail-closed이며 전용 TypeScript/TSX negative fixture로도 검증된다.

Install the pinned Playwright browser engines before the first cross-browser run:

corepack pnpm exec playwright install --with-deps chromium firefox webkit

Two gates intentionally need external evidence:

  • review:a11y-manual (release gate FE-GATE-028) needs a signed human keyboard/focus/screen-reader review of every registered route, one record per route at artifacts/tests/a11y-manual/<ROUTE_ID>.md. The routes are ROUTE_REGISTRY; verify:documentation fails, naming the route ID, when a registered route has no record. The merge gate FE-GATE-009 runs only review:a11y-manual -- --format-only, which checks that every route record keeps the template's fields, reviewed or still pending.
  • collect:web-vitals-evidence stays FAIL_UNVERIFIED until a reviewed minimum eligible-sample threshold and 28 days of production data exist.

Live hosting verification (FE-GATE-019, production stage) requires HOSTING_BASE_URL and the promoted release deployed by the workflow's deployment job. That job is an empty slot until the project fills it (docs/operations/ci-quality-gates.md); until then the result is UNVERIFIED, not PASS. A host serving another release fails.

CI and evidence

The gate registry is config/ci/gates.json; the Gitea workflow is .gitea/workflows/quality-gates.yml. It follows:

MERGE_READY -> RELEASE_READY -> PROD_PROMOTION_READY -> FIELD_SLO_READY

DOCUMENTATION_READY is independent. No gate is downgraded to a warning.

The workflow runs on pull requests, pushes to main and develop, and v* tags. The Git host of this repository may not have Actions enabled, so a pull request can show no gate status at all; no status is not a pass. Until the host runs the workflow and marks the merge gates as required checks, run the 13 merge gates locally before merging (FE-GATE-008 and 009 need Playwright browsers):

for gate in 001 002 003 004 005 006 007 008 009 010 011 013 020; do
  corepack pnpm ci:gate -- "FE-GATE-$gate" || break
done

Machine-readable evidence is written below artifacts/; generated evidence is ignored by Git while .gitkeep files preserve the taxonomy.

Operational details are in docs/operations/, with incident procedures in docs/runbooks/.

Updating a copied project

Template versions are Git tags vX.Y.Z. CHANGELOG.md lists the changes between tags, marks security fixes [보안] and contract changes [계약] (backend, deployment, CI or feature code must change too), and names the affected paths.

Record where you started. Right after copying, commit a one-line .template-origin file at the root of your project with the template tag (or commit) you copied and the date, for example v0.2.0 2026-09-26.

Take a template fix with Git. cherry-pick works even when your repository does not share the template's history, because it merges against the picked commit's parent:

git remote add template <template repository URL>
git fetch template --tags
git log --oneline <your origin>..template/main   # what changed since you copied
git cherry-pick -x <commit>                      # one fix; -x records its origin

When the files have moved or diverged too far for a clean pick, read the change as a diff and apply it by hand:

git diff <commit>^ <commit> -- <paths from CHANGELOG>

Afterwards run the local merge gates from "CI and evidence", apply the backend or deployment change a [계약] row names, and update .template-origin once you have caught up to a tag. git revert undoes a pick.

Defects: if a problem reproduces on an unmodified checkout of your .template-origin commit, it is a template defect. Report it on the template repository with that commit and the reproduction; the template maintainer classifies it and ships the fix with a CHANGELOG entry. A problem that needs your changes to reproduce belongs to your project, and applying a template fix to your copy is your project's job.