opentakeoff: Instructions file for Codex

AGENTS.md — a map of this repo for coding agents (and fast-moving humans)

OpenTakeoff is a client-only React app: a PDF construction-takeoff canvas for flooring (useful for any trade). No backend, no database, no auth—everything runs and persists in the browser. Apache-2.0. (For the one-page project pitch and vision, see AGENT_BRIEF.md; for capability → code mapping, see FEATURES.md.)

Run / build / check

cd web
nvm use          # Node pinned by web/.nvmrc (CI reads the same file)
npm install
npm run dev      # http://localhost:5173 — hot reload
npm test         # node:test over the pure geometry + totals math (test/*.test.ts)
npm run build    # → web/dist/ (static output; this is what Netlify deploys)
npm run check    # typecheck + lint + test + build — exactly what CI runs; green here ⇒ green CI

Shipping — the required steps, every change

main is protected on GitHub by a ruleset (PR-only, one approving review, green web check, branch up to date—the repo owner has a standing bypass as the solo maintainer). Merging to main deploys to production (https://opentakeoff.kentucky-ai.com)—Netlify's own git integration builds the merge commit and publishes it. netlify.toml holds the whole recipe (base = "web", command = npm run build, publish = "dist"), so the deploy runs a fresh build from the merged source; nothing is uploaded from CI.

.github/workflows/deploy.yml used to do this by publishing web/dist with --no-build, and it was deleted on 2026-07-13 in e701f1a ("deploys here are manual CLI; it fails on every push without the fork's secrets"). Only ci.yml (the web check the ruleset gates on) and publish-mcp.yml (fires on an mcp-v* tag) remain. The old line here said "Netlify never builds anything itself", which is now exactly backwards—Netlify is the only thing that builds production. Merge = deploy either way: that part has never changed.

This is the canonical Kentucky-ai/opentakeoff repo—production is https://opentakeoff.kentucky-ai.com, nothing else. A downstream fork (knmurphy/opentakeoff) tracks this repo as its own upstream and deploys separately to takeoff.345flooring.com—that URL belongs to that fork, not this repo. If you see takeoff.345flooring.com referenced elsewhere in this repo's docs, it's either an example value in the optional cloud-mode guides or leftover content from that fork's docs that rode along in a wholesale history merge (2026-07-13)—treat it as describing the downstream fork's deployment, not this one's.