|
| 1 | +# @bitbybit-dev/create-app |
| 2 | + |
| 3 | +🚀 **CLI tool to scaffold Bit By Bit Developers 3D/CAD projects with your favorite game engine** |
| 4 | + |
| 5 | +Create stunning 3D/CAD applications with ease using our powerful geometry kernels: OCCT (OpenCascade), JSCAD, and Manifold. |
| 6 | + |
| 7 | +## Quick Start |
| 8 | + |
| 9 | +### Using npm init (Recommended) |
| 10 | + |
| 11 | +```bash |
| 12 | +npm init @bitbybit-dev/app my-project |
| 13 | +``` |
| 14 | + |
| 15 | +### Using npx |
| 16 | + |
| 17 | +```bash |
| 18 | +npx @bitbybit-dev/create-app my-project |
| 19 | +``` |
| 20 | + |
| 21 | +## Usage |
| 22 | + |
| 23 | +### Interactive Mode |
| 24 | + |
| 25 | +Simply run the command without options to enter interactive mode: |
| 26 | + |
| 27 | +```bash |
| 28 | +npm init @bitbybit-dev/app my-project |
| 29 | +``` |
| 30 | + |
| 31 | +You'll be prompted to select: |
| 32 | +- 🎮 **Game Engine**: Three.js, Babylon.js, or PlayCanvas |
| 33 | + |
| 34 | +### CLI Options |
| 35 | + |
| 36 | +```bash |
| 37 | +npm init @bitbybit-dev/app my-project --engine threejs |
| 38 | +``` |
| 39 | + |
| 40 | +Available engines: |
| 41 | +- `threejs` - Three.js: Lightweight and flexible 3D library |
| 42 | +- `babylonjs` - Babylon.js: Powerful and feature-rich game engine |
| 43 | +- `playcanvas` - PlayCanvas: Fast and lightweight WebGL game engine |
| 44 | + |
| 45 | +## What You Get |
| 46 | + |
| 47 | +Each scaffolded project includes: |
| 48 | + |
| 49 | +- ⚡ **Vite** - Lightning fast build tool |
| 50 | +- 📘 **TypeScript** - Type-safe development |
| 51 | +- 🎨 **Bitbybit** - All geometry kernels pre-configured: |
| 52 | + - **OCCT** (OpenCascade) - Professional CAD kernel |
| 53 | + - **JSCAD** - Programmatic solid modeling |
| 54 | + - **Manifold** - Fast mesh boolean operations |
| 55 | +- 🎮 **Your chosen 3D engine** - Three.js, Babylon.js, or PlayCanvas |
| 56 | + |
| 57 | +## After Scaffolding |
| 58 | + |
| 59 | +Navigate to your project and start developing: |
| 60 | + |
| 61 | +```bash |
| 62 | +cd my-project |
| 63 | +npm install |
| 64 | +npm run dev |
| 65 | +``` |
| 66 | + |
| 67 | +## Project Structure |
| 68 | + |
| 69 | +``` |
| 70 | +my-project/ |
| 71 | +├── index.html |
| 72 | +├── package.json |
| 73 | +├── tsconfig.json |
| 74 | +├── public/ |
| 75 | +│ └── vite.svg |
| 76 | +└── src/ |
| 77 | + ├── main.ts |
| 78 | + ├── style.css |
| 79 | + └── vite-env.d.ts |
| 80 | +``` |
| 81 | + |
| 82 | +## Links |
| 83 | + |
| 84 | +- 🌐 **Website**: [https://bitbybit.dev](https://bitbybit.dev) |
| 85 | +- 📚 **Documentation**: [https://bitbybit.dev/docs](https://bitbybit.dev/docs) |
| 86 | +- 💬 **Discord Community**: [https://discord.gg/GSe3VMe](https://discord.gg/GSe3VMe) |
| 87 | +- 🐛 **Issues**: [https://github.com/bitbybit-dev/bitbybit/issues](https://github.com/bitbybit-dev/bitbybit/issues) |
| 88 | + |
| 89 | +## Support Us |
| 90 | + |
| 91 | +⭐ **The best way to support Bit By Bit Developers is with a Silver or Gold plan subscription!** |
| 92 | + |
| 93 | +[Subscribe Now](https://bitbybit.dev/auth/pick-plan) |
| 94 | + |
| 95 | +## License |
| 96 | + |
| 97 | +MIT © [Bit By Bit Developers](https://bitbybit.dev) |
0 commit comments