https://github.com/drmrd/vernacular
Open-source floor planner for power users, with first-class support for historic and period-vernacular architecture.
https://github.com/drmrd/vernacular
architecture floorplanning historic-preservation open-source react threejs typescript vernacular-architecture webgpu
Last synced: 25 days ago
JSON representation
Open-source floor planner for power users, with first-class support for historic and period-vernacular architecture.
- Host: GitHub
- URL: https://github.com/drmrd/vernacular
- Owner: drmrd
- License: apache-2.0
- Created: 2026-06-02T15:25:31.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-06-29T07:29:01.000Z (28 days ago)
- Last Synced: 2026-06-29T08:22:00.894Z (28 days ago)
- Topics: architecture, floorplanning, historic-preservation, open-source, react, threejs, typescript, vernacular-architecture, webgpu
- Language: TypeScript
- Homepage:
- Size: 20.9 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
# 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 development (Phase 0). Not yet usable as a floor planner.
> See [`docs/specs/2026-06-01-vernacular-design.md`](docs/specs/2026-06-01-vernacular-design.md)
> for the design specification and [`docs/plans/`](docs/plans/) for in-progress
> implementation plans. The current work and what's next are tracked on the
> [delivery roadmap board](https://github.com/users/drmrd/projects/3); the
> strategy and track model are in
> [`docs/delivery-strategy.md`](docs/delivery-strategy.md).
## Documentation map
- [`ARCHITECTURE.md`](ARCHITECTURE.md): one-page overview of the six-layer
codebase and where to find things.
- [`docs/delivery-strategy.md`](docs/delivery-strategy.md): delivery strategy and
track model. Live per-item status is on the
[delivery roadmap board](https://github.com/users/drmrd/projects/3).
- [`CONTRIBUTING.md`](CONTRIBUTING.md): contribution workflow, dev setup,
conventions.
- [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md): community standards.
- [`SECURITY.md`](SECURITY.md): how to report security issues.
- [`CHANGELOG.md`](CHANGELOG.md): notable changes per release.
- `docs/specs/`: authoritative design specifications.
- `docs/plans/`: per-phase implementation plans.
## Development
Prerequisites:
- Node.js 20+ (see `.nvmrc`)
- pnpm 10+ (the version is pinned via `packageManager` in `package.json`;
using corepack means you do not need to install pnpm yourself)
```sh
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`](CONTRIBUTING.md) for the full contribution flow.
## License
Apache-2.0. See [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE).