8000 GitHub - dzervas/cadara: An in-browser, local CAD for human beings · GitHub
[go: up one dir, main page]

Skip to content
dzervasPublic

About

An in-browser, local CAD for human beings

Resources

Stars

39 stars

Watchers

0 watching

Forks

Latest commit

 

History

1,117 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CADara

CADara is an open-source, browser based CAD application. Everything happens on the browser, you can use it completely offline.

Give it a spin!

Development and deployment

The toolchain is Bun (version in package.json packageManager). With devenv, devenv shell (or direnv) provides it plus Playwright's chromium and fonts; without devenv, install Bun and run bunx playwright install chromium once for the E2E lane.

bun install --frozen-lockfile
bun run dev

/ is the landing page; /app is the editor. bun run build builds both, including the landing used for unknown-page/404 responses, into dist/. Cloudflare Workers Static Assets uses wrangler.jsonc; wrangler deploy runs the same build. HTML paths canonicalize without trailing slashes, and unknown pages display the landing with a real 404 status. Shared assets stay at root URLs, so editor workers, icons, and offline caching also work at /app.

  • PLAYWRIGHT_GPU=1 bun run test:e2e — opt into GPU-accelerated Chromium locally (default/CI stay on headless-shell SwiftShader).
  • bun run preview — preview the Vite output.
  • bun run preview:cf — build and serve it through the local Cloudflare runtime.
  • bun run test:e2e:cloudflare — verify the built Cloudflare routes and editor handoff. The local emulator requires a runnable workerd binary; Nix environments may need a compatible patched binary through MINIFLARE_WORKERD_PATH.
  • bun run landing:models:build — regenerate the CLI-built landing examples.

Landing source lives in landing/. landing/examples/ contains only the three native documents, preview meshes, and manifests, grouped by model. Rebuild scripts in landing/scripts/ keep intermediate recipes and logs in OS temporary directories, not the served model folder. A complete model rebuild takes many minutes; it is not part of the normal web build.

Contracts for Bun consumers

Pin the public repository to a commit. Bun requires explicit trust to run a git package's prepare script (lifecycle documentation):

{
  "dependencies": { "cadara": "github:dzervas/cadara#<sha>" },
  "trustedDependencies": ["cadara"]
}

Run bun install with lifecycle scripts enabled (no --ignore-scripts or install.ignoreScripts = true in the consumer). Preparation compiles the contracts and their Typia validators into dist/contracts; the consumer needs neither a Typia plugin nor CADara's Bun preload.

import { parseAuthoredModelDocument } from "cadara/contracts";
import type { CollaborativeDocument } from "cadara/contracts/documents";
import type { AuthoredModelDocument } from "cadara/contracts/modeling/authored-document";

const result = parseAuthoredModelDocument(JSON.parse(savedCadaraJson));
if (!result.ok) throw new Error(JSON.stringify(result.diagnostic));

cadara/contracts/* mirrors every production module under src/contracts (without .ts; directory entries use /index). New contract modules are picked up automatically at build time. The root subpath offers the authored-document parser and its document/result types. cadara/contracts/documents is a separate, type-only entry for the core-owned collaborative storage document; the runtime contracts surface never imports core, application, or infrastructure modules.

For a local file: dependency, first run bun run build:contracts in the CADara checkout: Bun does not run prepare for file: packages, and this repository's bunfig.toml disables lifecycle scripts on its own installs. Generated JS and portable declarations are not committed. The web build replaces dist/, so re-run build:contracts after building the web app if using this checkout as a local dependency. The separately built cadara-cli package is unchanged.

Account API

Sign-in is optional; local projects remain available without an account. Set VITE_CADARA_API_ORIGIN at Vite start/build time to the CADara API origin (no path). It defaults to http://localhost:8787 in development and https://api.cadara.app in production. The API must trust the app's exact origin for CORS and Better Auth. Browser requests include credentials; session cookies remain host-only on the API. Google/GitHub require providers configured on the API, and passkeys require a secure context (or localhost) and the API's configured RP ID.

The opt-in browser sign-in regression (e2e/account-sign-in.spec.ts) needs a local API using the memory mailer. Capture wrangler stdout to a private file and set CADARA_AUTH_MAILER_LOG to that absolute path when running Playwright; do not publish that file (it contains one-time sign-in links). Set PLAYWRIGHT_WEB_SERVER=0 and PLAYWRIGHT_BASE_URL to your own Vite origin. If port 3000 is occupied, wrangler --var overrides can set APP_ORIGIN, TRUSTED_ORIGINS and AUTH_BASE_URL for that run without changing the server's configuration. Keep the browser and API on localhost rather than mixing it with 127.0.0.1, so same-site API cookies work.

About

An in-browser, local CAD for human beings

Resources

Stars

39 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

0