Skip to content

Requirements: Local Development Tooling

Requirements for Part 3 of Component Preparation.

Note: The analysis found that tools/dev-local.sh, the dev:local npm script entry, and README.md documentation already exist. Requirements below are specified for completeness; those already met are noted.

REQ-LT-001: dev-local.sh Script (already implemented)

Section titled “REQ-LT-001: dev-local.sh Script (already implemented)”

tools/dev-local.sh must:

  1. Build ux-prototype (vite, with type declarations) and api-proxy (tsc)
  2. Start background watch-mode rebuilds (logs to scratch/)
  3. Link packages into node_modules via npm link --no-save (does not modify package.json)
  4. Start Next.js dev server in mock mode with --webpack flag
  5. On exit (Ctrl+C, error, or termination), restore node_modules from registry via npm install
  6. Accept optional port argument (default 3000)

REQ-LT-002: npm Script Entry (already implemented)

Section titled “REQ-LT-002: npm Script Entry (already implemented)”

package.json must contain "dev:local": "bash tools/dev-local.sh".

The Makefile must contain a dev-local target that invokes npm run dev:local. It must support port forwarding via arguments (e.g., make dev-local PORT=3001 or pass-through).

REQ-LT-004: README.md Documentation (already implemented)

Section titled “REQ-LT-004: README.md Documentation (already implemented)”

README.md must document the local development workflow including:

  • Prerequisites (sibling directory layout)
  • How to run (npm run dev:local or make dev-local)
  • Custom port usage
  • Constraints (--webpack requirement, npm install breaks links)

CLAUDE.md must document the dev:local workflow for agents, including the directory layout, commands, and constraints.

After all changes, the following checks must pass:

  • npm run lint
  • npx tsc --noEmit
  • npx jest --no-coverage --watchAll=false --forceExit
  • npm run build

CHANGELOG.md must be updated with entries for the Makefile target and any documentation updates added in this part.


Copyright: (c) Arda Systems 2025-2026, All rights reserved