Skip to content

Commit 2864ea8

Browse files
included info about npx command inside intro on npm packages
1 parent 3c77e1c commit 2864ea8

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

docs/learn/npm-packages/intro.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,46 @@ tags: [npm-packages, threejs, babylonjs, playcanvas, occt, manifold, jscad]
1010

1111
When developing standalone applications in TypeScript or JavaScript, you often use third-party libraries and frameworks. We've developed several open-source NPM packages (MIT Licensed) to help you integrate our powerful 3D CAD algorithms directly into your applications.
1212

13+
---
14+
15+
## Quick Start with CLI
16+
17+
The fastest way to get started is with our CLI tool. Scaffold a fully-configured 3D CAD project in seconds:
18+
19+
```bash
20+
npx @bitbybit-dev/create-app my-awesome-project
21+
```
22+
23+
The CLI guides you through an interactive setup where you choose your preferred 3D engine (Three.js, Babylon.js, or PlayCanvas). You can also specify the engine directly:
24+
25+
```bash
26+
npx @bitbybit-dev/create-app my-project --engine babylonjs
27+
```
28+
29+
### What You Get
30+
31+
Your scaffolded project includes:
32+
33+
- **Vite** for fast development and optimized production builds
34+
- **TypeScript** configured out of the box
35+
- **All three geometry kernels** pre-configured and ready to use:
36+
- **OCCT** (OpenCascade) for professional CAD operations
37+
- **JSCAD** for programmatic solid modeling
38+
- **Manifold** for fast mesh boolean operations
39+
- **Starter code** demonstrating each kernel's capabilities
40+
41+
### Development Workflow
42+
43+
```bash
44+
cd my-awesome-project
45+
npm install
46+
npm run dev
47+
```
48+
49+
Your browser opens with a live 3D preview at `http://localhost:5173`. Changes appear instantly with hot reload.
50+
51+
---
52+
1353
## Architecture of NPM Packages
1454

1555
The following diagram illustrates the architecture of our NPM packages. Each game engine-specific package (`@bitbybit-dev/threejs`, `@bitbybit-dev/babylonjs`, `@bitbybit-dev/playcanvas`) connects through the `@bitbybit-dev/core` layer. This creates a streamlined, extensible structure that supports a range of integrations with various geometry kernels like OCCT, JSCAD, and Manifold.

0 commit comments

Comments
 (0)