create-box-app

Scaffold a new BOX Framework project in seconds

Quick Start

npx create-box-app my-project
cd my-project
npm install
npm run dev

That's it! Your BOX app is ready at http://localhost:3000

What's Inside

The scaffolder creates a minimal BOX project with:

• ✅ Pre-configured .vscode settings for HTML syntax highlighting
• ✅ Sample main.box component demonstrating the framework
• ✅ Example API endpoint (api+hello.box)
• ✅ Ready-to-use npm scripts (dev, build, start)
• ✅ Clean folder structure following BOX conventions

Features

• Zero Setup: No global installs. Just npx and go.
• Fast: Generates a working project in under 5 seconds
• Minimal: Only essential files, no bloat
• Beautiful: Includes a stylish welcome component

Commands

Once your project is created:

npm run dev      # Start dev server with HMR
npm run build    # Build for production
npm start        # Run production server

Learn More

• BOX Framework Docs
• GitHub Repository

License

MIT © Itay Zrihan