@bitbybit-dev/jscad 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -44
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -1,64 +1,99 @@
|
|
|
1
|
-
|
|
1
|
+
# @bitbybit-dev/jscad
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
Best way to support us - [Silver or Gold plan subscription](https://bitbybit.dev/auth/pick-plan)
|
|
5
|
-
Buy unique products from our [Crafts shop](https://crafts.bitbybit.dev) all designed with Bitbybit algorithms
|
|
6
|
-
Check out [3D Bits app for Shopify](https://apps.shopify.com/3d-bits-1) also used in our Crafts shop
|
|
3
|
+
[JSCAD](https://github.com/jscad) solid modeling integration for [Bitbybit](https://bitbybit.dev) - programmatic CSG operations, extrusions, hulls, and more for creating precise 3D geometry through code.
|
|
7
4
|
|
|
8
5
|
<img src="https://app.bitbybit.dev/assets/git-cover.png" alt="Picture showing bitbybit.dev platform">
|
|
9
6
|
|
|
10
|
-
|
|
7
|
+
## Overview
|
|
11
8
|
|
|
12
|
-
|
|
13
|
-
https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/jscad
|
|
14
|
-
## NPM
|
|
15
|
-
https://www.npmjs.com/package/@bitbybit-dev/jscad
|
|
9
|
+
This package wraps the [OpenJSCAD](https://github.com/jscad) 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.
|
|
16
10
|
|
|
17
|
-
|
|
18
|
-
Vase
|
|
19
|
-
https://app-store.bitbybit.dev/vase
|
|
20
|
-
Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/threejs/vase
|
|
11
|
+
Works in both **Node.js** and **browser** environments. For browser apps, we recommend [@bitbybit-dev/jscad-worker](https://www.npmjs.com/package/@bitbybit-dev/jscad-worker) which wraps this library in a non-blocking WebWorker.
|
|
21
12
|
|
|
22
|
-
##
|
|
23
|
-
Laptop Holder
|
|
24
|
-
https://app-store.bitbybit.dev/laptop-holder
|
|
25
|
-
Github Source Code Angular - https://github.com/bitbybit-dev/app-examples/tree/main/angular/laptop-holder
|
|
26
|
-
Github Source Code React - https://github.com/bitbybit-dev/app-examples/tree/main/react/laptop-holder
|
|
27
|
-
|
|
28
|
-
Cup Configurator
|
|
29
|
-
https://app-store.bitbybit.dev/cup
|
|
30
|
-
Github Source Code - https://github.com/bitbybit-dev/app-examples/tree/main/react/cup
|
|
13
|
+
## Quick Start
|
|
31
14
|
|
|
32
|
-
|
|
33
|
-
https://app-store.bitbybit.dev/terrace-furniture
|
|
15
|
+
The fastest way to scaffold a project with JSCAD pre-configured:
|
|
34
16
|
|
|
35
|
-
|
|
17
|
+
```bash
|
|
18
|
+
npx @bitbybit-dev/create-app my-project --engine threejs
|
|
19
|
+
cd my-project
|
|
20
|
+
npm install
|
|
21
|
+
npm run dev
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This creates a complete Vite + TypeScript project with JSCAD, OCCT, and Manifold kernels ready to use. [Learn more about the CLI](https://learn.bitbybit.dev/learn/npm-packages/intro).
|
|
25
|
+
|
|
26
|
+
### Need Server-Side CAD?
|
|
27
|
+
|
|
28
|
+
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:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx @bitbybit-dev/create-app my-cloud-project --type cloud
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Choose 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](https://learn.bitbybit.dev/api/sdk/typescript/pipelines). [Learn more](https://learn.bitbybit.dev/api/cloud-api).
|
|
35
|
+
|
|
36
|
+
## Links
|
|
37
|
+
|
|
38
|
+
| Resource | URL |
|
|
39
|
+
|----------|-----|
|
|
40
|
+
| **GitHub** | https://github.com/bitbybit-dev/bitbybit/tree/master/packages/dev/jscad |
|
|
41
|
+
| **Monorepo** | https://github.com/bitbybit-dev/bitbybit |
|
|
42
|
+
| **NPM** | https://www.npmjs.com/package/@bitbybit-dev/jscad |
|
|
43
|
+
| **Documentation** | https://learn.bitbybit.dev/learn/npm-packages/intro |
|
|
44
|
+
| **Unit Test Coverage** | https://tests.bitbybit.dev/jscad |
|
|
45
|
+
|
|
46
|
+
## Example Applications
|
|
47
|
+
|
|
48
|
+
| App | Source Code |
|
|
49
|
+
|-----|-------------|
|
|
50
|
+
| [Hex Shell](https://learn.bitbybit.dev/learn/npm-packages/threejs/advanced-parametric-3d-model) | [GitHub](https://github.com/bitbybit-dev/bitbybit/tree/master/examples/vite/threejs/hex-shell) |
|
|
51
|
+
| [Cup Configurator](https://app-store.bitbybit.dev/cup) | [GitHub](https://github.com/bitbybit-dev/bitbybit/tree/master/examples/vite/threejs/cup) |
|
|
52
|
+
| [Terrace Furniture](https://app-store.bitbybit.dev/terrace-furniture) (BabylonJS) | Closed source |
|
|
53
|
+
|
|
54
|
+
## Development
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
# Build package
|
|
36
58
|
npm run build-p
|
|
37
59
|
|
|
38
|
-
|
|
60
|
+
# Run unit tests with coverage
|
|
39
61
|
npm run test-c
|
|
40
62
|
|
|
41
|
-
|
|
63
|
+
# Run live unit tests with coverage on save
|
|
42
64
|
npm run test-c-l
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Bitbybit Platform
|
|
68
|
+
|
|
69
|
+
Beyond NPM packages, Bitbybit offers:
|
|
70
|
+
|
|
71
|
+
- **[Visual Programming Editors](https://bitbybit.dev)** - Rete & Blockly drag-and-drop 3D modeling, plus a Monaco TypeScript editor
|
|
72
|
+
- **[CAD Cloud API](https://learn.bitbybit.dev/api/cloud-api)** - Build full [pipelines](https://learn.bitbybit.dev/api/sdk/typescript/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
|
|
73
|
+
- **[Bitbybit Studio](https://studio.bitbybit.dev)** - A growing visual dashboard where API Key users can generate models, convert files, build [pipelines with a GUI](https://learn.bitbybit.dev/api/studio/intro), inspect tasks, and preview 3D results
|
|
74
|
+
- **[3D Bits for Shopify](https://apps.shopify.com/3d-bits-1)** - Interactive 3D product configurators for e-commerce
|
|
75
|
+
- **[Script Runners](https://learn.bitbybit.dev/learn/runners/intro)** - Execute visual scripts directly on your website
|
|
76
|
+
- **[AI-Assisted Development](https://learn.bitbybit.dev/learn/using-ai-with-bitbybit/intro)** - Context files for GitHub Copilot, Claude, and ChatGPT
|
|
77
|
+
- **[Business & Enterprise](https://bitbybit.dev/b2b)** - We help businesses and enterprises develop custom applications and spin up optimized CAD tenant workflows on our managed servers
|
|
43
78
|
|
|
44
|
-
##
|
|
45
|
-
https://tests.bitbybit.dev/threejs
|
|
79
|
+
## Support the Project
|
|
46
80
|
|
|
47
|
-
|
|
48
|
-
Discord: https://discord.gg/GSe3VMe
|
|
49
|
-
Youtube: https://www.youtube.com/@bitbybitdev?sub_confirmation=1
|
|
50
|
-
Instagram: https://www.instagram.com/bitbybit.dev
|
|
51
|
-
Twitter: https://twitter.com/bitbybit_dev
|
|
52
|
-
LinkedIn: https://lnkd.in/gQjEQA2
|
|
53
|
-
Facebook: https://www.facebook.com/bitbybitdev
|
|
54
|
-
Medium: https://bitbybit-dev.medium.com/
|
|
81
|
+
This package is part of the open-source Bitbybit ecosystem. Your subscription helps fund continued development.
|
|
55
82
|
|
|
56
|
-
|
|
57
|
-
Bit By Bit Developers company will keep these core algorithms that you can find in this repository free and opensource for its users. These algorithms are based on other open-source projects, run and are deployed on the browser, thus there is no point of closing them down from public.
|
|
83
|
+
⭐ **[Subscribe - Silver or Gold plan](https://bitbybit.dev/auth/pick-plan)** | **[Get API Key for CAD Cloud](https://bitbybit.dev/auth/pick-plan?api-keys=true)**
|
|
58
84
|
|
|
59
|
-
##
|
|
60
|
-
|
|
85
|
+
## Community
|
|
86
|
+
|
|
87
|
+
- [Discord](https://discord.gg/GSe3VMe)
|
|
88
|
+
- [YouTube](https://www.youtube.com/@bitbybitdev?sub_confirmation=1)
|
|
89
|
+
- [LinkedIn](https://www.linkedin.com/company/bitbybit-dev)
|
|
90
|
+
- [X (Twitter)](https://x.com/bitbybit_dev)
|
|
91
|
+
- [Blog](https://learn.bitbybit.dev/blog)
|
|
61
92
|
|
|
62
93
|
## Major Dependencies
|
|
63
|
-
|
|
64
|
-
https://github.com/jscad
|
|
94
|
+
|
|
95
|
+
[JSCAD](https://github.com/jscad)
|
|
96
|
+
|
|
97
|
+
## License
|
|
98
|
+
|
|
99
|
+
MIT © [Bit By Bit Developers](https://bitbybit.dev)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bitbybit-dev/jscad",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Bit By Bit Developers JSCAD based CAD Library to Program Geometry",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"repository": {
|
|
@@ -55,10 +55,14 @@
|
|
|
55
55
|
},
|
|
56
56
|
"author": "Bit by bit developers",
|
|
57
57
|
"license": "MIT",
|
|
58
|
+
"funding": {
|
|
59
|
+
"type": "corporate",
|
|
60
|
+
"url": "https://bitbybit.dev/auth/pick-plan"
|
|
61
|
+
},
|
|
58
62
|
"types": "./index.d.ts",
|
|
59
63
|
"type": "module",
|
|
60
64
|
"dependencies": {
|
|
61
|
-
"@bitbybit-dev/base": "1.0.
|
|
65
|
+
"@bitbybit-dev/base": "1.0.1",
|
|
62
66
|
"@jscad/io-utils": "2.0.28",
|
|
63
67
|
"@jscad/modeling": "2.12.3",
|
|
64
68
|
"@jscad/stl-serializer": "2.1.18",
|