Vernacular

Open-source floor planner for power users, with first-class support for historic and period-vernacular architecture. Built for owners and enthusiasts of houses that mainstream floor planners don't represent well: Victorian, Edwardian, Craftsman, Mid-Century, and earlier.

Status: early alpha. The 2D editor and 3D preview are usable; data formats and APIs may change without backwards compatibility before 1.0 (releases in CHANGELOG.md). See docs/specs/2026-06-01-vernacular-design.md for the design specification and docs/plans/ for in-progress implementation plans. The current work and what's next are tracked on the delivery roadmap board; the strategy and track model are in docs/delivery-strategy.md.

Documentation map

• ARCHITECTURE.md: one-page overview of the six-layer codebase and where to find things.
• docs/delivery-strategy.md: delivery strategy and track model. Live per-item status is on the delivery roadmap board.
• CONTRIBUTING.md: contribution workflow, dev setup, conventions.
• CODE_OF_CONDUCT.md: community standards.
• SECURITY.md: how to report security issues.
• CHANGELOG.md: notable changes per release.
• docs/specs/: authoritative design specifications.
• docs/plans/: per-phase implementation plans.

Development

Prerequisites:

• Node.js 22.18+ (see .nvmrc and engines in package.json)
• pnpm 10+ (the version is pinned via packageManager in package.json; using corepack means you do not need to install pnpm yourself)

pnpm install
pnpm dev        # start dev server (http://localhost:5173)
pnpm test       # run unit tests
pnpm typecheck  # TypeScript type check
pnpm lint       # ESLint
pnpm build      # production build to dist/

See CONTRIBUTING.md for the full contribution flow.

License

Apache-2.0. See LICENSE and NOTICE.