@bitbybit-dev/jscad
v1.1.1
Published
Bit By Bit Developers JSCAD based CAD Library to Program Geometry
Maintainers
Readme
@bitbybit-dev/jscad
JSCAD solid modeling integration for Bitbybit - programmatic CSG operations, extrusions, hulls, and more for creating precise 3D geometry through code.
Overview
This package wraps the OpenJSCAD kernel with additional algorithms from Bitbybit. JSCAD excels at programmatic solid modeling using constructive solid geometry (CSG) - perfect for parametric designs, mechanical parts, and 3D-printable models.
Works in both Node.js and browser environments. For browser apps, we recommend @bitbybit-dev/jscad-worker which wraps this library in a non-blocking WebWorker.
Quick Start
The fastest way to scaffold a project with JSCAD pre-configured:
npx @bitbybit-dev/create-app my-project --engine threejs
cd my-project
npm install
npm run devThis creates a complete Vite + TypeScript project with JSCAD, OCCT, and Manifold kernels ready to use. Learn more about the CLI.
Need Server-Side CAD?
The CLI first asks you to choose between a Frontend app or a CAD Cloud app. Select "cloud" to scaffold a full-stack project with a backend (Hono on Cloudflare Workers, Node.js Express, or ASP.NET Core) and a React + Three.js frontend. Your API key stays on the server and the frontend proxies requests through your backend:
npx @bitbybit-dev/create-app my-cloud-project --type cloudChoose from 5 backend templates: Hono + SDK, Hono + REST, Node.js + SDK, Node.js + REST, or .NET + REST. Each includes ready-to-run examples with model generation, batch operations, and CAD pipelines. Learn more.
Links
| Resource | URL | |----------|-----| | GitHub | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/jscad | | Monorepo | https://github.com/bitbybit-dev/bitbybit | | NPM | https://www.npmjs.com/package/@bitbybit-dev/jscad | | Documentation | https://learn.bitbybit.dev/learn/npm-packages/intro | | Unit Test Coverage | https://tests.bitbybit.dev/jscad |
Example Applications
| App | Source Code | |-----|-------------| | Hex Shell | GitHub | | Cup Configurator | GitHub | | Terrace Furniture (BabylonJS) | Closed source |
Development
# Build package
npm run build-p
# Run unit tests with coverage
npm run test-c
# Run live unit tests with coverage on save
npm run test-c-lBitbybit Platform
Beyond NPM packages, Bitbybit offers:
- Visual Programming Editors - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor
- CAD Cloud API - Build full pipelines that compose all Bitbybit algorithms, where each step can reference outputs of previous steps. Supports parametric model generation, STEP-to-glTF conversion, and complex CAD workflows via HTTP
- Bitbybit Studio - A growing visual dashboard where API Key users can generate models, convert files, build pipelines with a GUI, inspect tasks, and preview 3D results
- 3D Bits for Shopify - Interactive 3D product configurators for e-commerce
- Script Runners - Execute visual scripts directly on your website
- AI-Assisted Development - Context files for GitHub Copilot, Claude, and ChatGPT
- Business & Enterprise - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers
Support the Project
This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.
⭐ Subscribe - Silver or Gold plan | Get API Key for CAD Cloud
Community
Major Dependencies
License
MIT © Bit By Bit Developers
