@bitbybit-dev/base
v1.0.1
Published
Bit By Bit Developers Base CAD Library to Program Geometry
Maintainers
Readme
@bitbybit-dev/base
Base algorithms for Bitbybit CAD platform - math, vectors, matrices, lists, text utilities, and shared types used across all higher-level packages.
Overview
This package provides the foundational layer for all Bitbybit CAD packages. It includes helper functions for math, text, lists, vectors, and matrix operations, along with base types used throughout the platform. This layer is kept lightweight with zero third-party dependencies.
Works in both Node.js and browser environments.
Used By
This package is a dependency of all higher-level Bitbybit packages:
- @bitbybit-dev/occt - OpenCascade CAD kernel
- @bitbybit-dev/occt-worker - OCCT via WebWorker
- @bitbybit-dev/manifold - Manifold mesh booleans
- @bitbybit-dev/manifold-worker - Manifold via WebWorker
- @bitbybit-dev/jscad - JSCAD solid modeling
- @bitbybit-dev/jscad-worker - JSCAD via WebWorker
- @bitbybit-dev/core - Core assembly layer
- @bitbybit-dev/babylonjs - BabylonJS integration
- @bitbybit-dev/threejs - Three.js integration
- @bitbybit-dev/playcanvas - PlayCanvas integration
Quick Start
The fastest way to start a project using Bitbybit packages:
npx @bitbybit-dev/create-app my-projectThis scaffolds a complete Vite + TypeScript project with all CAD kernels pre-configured. Learn more about the CLI.
Links
| Resource | URL | |----------|-----| | GitHub | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/base | | Monorepo | https://github.com/bitbybit-dev/bitbybit | | NPM | https://www.npmjs.com/package/@bitbybit-dev/base | | Documentation | https://learn.bitbybit.dev/learn/npm-packages/intro | | Unit Test Coverage | https://tests.bitbybit.dev/base |
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
License
MIT © Bit By Bit Developers
