Files
clean-architecture-frontend…/README.md
T
DongHyeonka 61baf96682 fix(docs): 입구 문서를 실제 src 폴더 9개와 규칙 이름에 맞추고 검사한다 (14-03)
문제: src/ 최상위 폴더는 adapters application apps bootstrap contexts
contracts features platform presentation 9개다. layers.md 표,
frontend-application-foundation.md 목록, overview.md 그림, README 구조
그림은 src/platform을 한 번도 적지 않았고 apps·contexts는 금지 간선
설명에만 나왔다. 대신 없는 최상위 domain을 계층으로 그렸다.
contract-ownership.md의 배치 규칙에는 src/platform 선택지가 없었다.
layers.md는 "표와 규칙이 어긋날 수 없다"고 적었지만
.dependency-cruiser.json 규칙 31개 중 25개의 이름이 없었다.
게이트는 금지 간선만 막으므로, 허용되지만 틀린 자리(최상위 domain 신설,
제품 중립 primitive를 contracts에 두기)를 문서로 막을 수 없었다.

고른 방법: 리뷰의 (B)안. 문서를 코드에 맞추고 verify:documentation에
대조 검사를 더한다.
- layers.md: 9개 폴더 표(폴더 | 소유)를 정본으로 두고, 금지 간선 글머리
  목록을 규칙 31개 표(규칙 이름 | 적용 대상 | 금지)로 바꾼다. domain은
  기능 안의 계층으로 옮기고 "최상위 domain 폴더는 지금 없고, 만들면
  domain-is-framework-neutral이 이미 적용된다"고 적는다. 보증 문장은
  실제로 검사하는 범위로 줄인다. kernel 절과 배럴 절은 그대로 둔다.
- README·overview·foundation: layers.md 표의 설명을 한 글자도 바꾸지
  않고 "`src/<폴더>` — <설명>" 목록으로 싣는다. 그림은 실제 import
  방향(presentation -> application -> contracts -> platform,
  apps -> contexts -> features)으로 다시 그린다.
- contract-ownership.md: src/platform 선택지와 contracts와의 차이,
  platform-kernel-is-product-neutral을 적는다.
- verify-documentation-readiness.ts: 폴더 목록은 src/를 읽고, 규칙 목록은
  .dependency-cruiser.json을 읽는다. layers.md 표에 행이 없는 폴더,
  나머지 세 문서에서 설명이 다른 폴더, 네 문서가 적은 없는 최상위
  src 폴더, layers.md에 없는 규칙 이름이 있으면 실패한다. 결과는
  documentation-review.json의 sourceStructure로 남긴다(스키마는 필드
  하나를 더한다).
버린 대안: (A) 문서만 고치기 — 규칙이나 폴더가 늘면 다시 어긋난다.
(C) layers.md를 .dependency-cruiser.json에서 생성 — 사람이 읽는 설명을
넣기 어렵다. 네 문서 모두에 규칙 31개를 싣는 것 — 같은 목록이 네 벌이
되어 어긋날 곳만 늘어난다. 규칙 표는 layers.md 한 곳에 둔다.

위험·한계:
- 검사는 규칙 이름이 있는지만 본다. 행의 설명이 규칙과 맞는지는 보지
  않는다(문서에도 그렇게 적었다).
- 없는 폴더 검사는 "src/<이름>" 꼴만 잡는다. "domain"처럼 src/ 없이
  계층 이름만 쓰는 것은 잡지 못한다.
- README·overview·foundation에는 같은 9줄이 복사되어 있다. 설명을 바꾸면
  네 곳을 함께 고쳐야 하고, 검사가 그것을 강제한다.
- .dependency-cruiser.json 주석의 "like src/domain"(feature-domain 규칙)은
  코드 주석이라 이번 범위 밖이다.
- 문서 drift 전반(경로·줄 번호, 14-05)은 다루지 않는다.

검증:
- RED: 새 검사를 기준 커밋(7a70cea)의 문서에 돌리면 FAIL_UNVERIFIED
  (failed: source structure). layers.md는 규칙 25개가 없고, 네 문서
  모두 9개 폴더를 설명하지 않는다고 나온다.
- GREEN: node scripts/verify-documentation-readiness.ts -> PASS_SCOPED.
  tests/unit/documentation-readiness.test.ts 6개 통과. 새 변이 3개:
  규칙 이름 하나를 바꾸면, README에 `src/domain`을 넣으면, overview의
  platform 설명을 바꾸면 각각 실패하고 원인 문서와 이름을 적는다.
- 회귀: tests/unit 전체(fixture-node-modules 제외, pnpm 설치를 띄운다)
  173파일 2494개 통과. ci-artifact-contract의 "semantically invalid"
  16개 통과. tsc(node, test) 통과, 바꾼 ts 파일 eslint 통과.
- 미실행: check:architecture(pnpm 필요, worktree에서 금지).

Refs: docs/reviews/2026-11-01-maturity-review/14-template-product-docs.md 14-03
2026-11-03 00:54:44 +09:00

20 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 profile value
RUNTIME_TELEMETRY_ENDPOINT TELEMETRY_ENDPOINT, overriding the profile 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 and non-HTTPS endpoints.

A production build and its admission check:

APP_PROFILE=production \
RUNTIME_API_BASE_URL=https://api.example.com/ \
RUNTIME_TELEMETRY_ENDPOINT=https://telemetry.example.com/v1/events \
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, and a persistent system / light / dark theme selector.

Route Purpose
/ implementation readiness and starter links
/examples/ui buttons, fields, cards, alerts, badges, modal, and tokens
/examples/states loading, refresh, empty, error, auth, forbidden, and not-found states
/examples/auth reactive external-auth integration seam
/examples/reference-resources removable, session-required reference feature

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 for all ten registered routes: APP_HOME, EXAMPLES_PLATFORM, EXAMPLES_UI, EXAMPLES_STATES, EXAMPLES_AUTH, NOT_FOUND, REFERENCE_RESOURCE_LIST, REFERENCE_RESOURCE_DETAIL, REFERENCE_RESOURCE_FORM and REFERENCE_RESOURCE_STATUS. verify:documentation derives that list from the route registry and fails if this paragraph falls behind it. 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 a deployed promoted release; without it the result is UNVERIFIED, not PASS.

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.