create-javel-app

Scaffold a Javel application with React, Vue, or Svelte.

Requirements

• Bun 1.1 or newer. This tool is built for Bun only.
• Git (recommended) or tar, so the starter template can be downloaded.

Do not use npm, yarn, or pnpm to create or run the app. Use bun and bunx throughout.

Usage

After publishing this package:

bunx create-javel-app

Inquirer prompts for the project folder (default javel-app) and for React, Vue, or Svelte when you omit flags.

The CLI clones the starter with git (git clone --depth 1). If git is missing or the clone fails, it falls back to downloading the repository tarball from GitHub. Then it runs bun install.

You can pass the directory and stack up front:

bunx create-javel-app my-app

Pass the stack directly:

bunx create-javel-app my-app --react
bunx create-javel-app my-app --vue
bunx create-javel-app my-app --svelte

Run locally from this folder before publish:

bun ./index.js ../my-app --vue

After scaffolding

cd my-app
bun jcc migrate
bun run dev
bun run watch

Open the URL printed by bun run dev (see .env for PORT). Run bun run watch in another terminal so Vite can serve the Inertia client.

Starters

| Stack | Repository | | ------ | --------------------------------------------------------------------------------------- | | React | jammehabdou64/bun-react-starter | | Vue | jammehabdou64/bun-vue-starter | | Svelte | jammehabdou64/bun-svelte-starter |

Each starter ships SQLite, session auth, and an Inertia dashboard. Set APP_KEY in .env (or run bun jcc key:generate when your bun-jcc version includes it).

Documentation

This package includes the Javel framework manual under documentation/. Use it while you build on a scaffolded app.

| Section | Start here | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Overview | documentation/README.md | | First steps | Introduction, Installation, Frontend | | HTTP & Inertia | Routing, Controllers, Inertia | | Auth (starter kit) | Authentication | | Database | Migrations, JCC Eloquent intro | | CLI | CLI reference |

After bun install in a starter, the same manual is also available at node_modules/bun-jcc/documentation (from the published bun-jcc package). Prefer that path inside an app so it matches your installed framework version.

All commands in the manual assume Bun (bun jcc, bun test, bun run dev). Do not substitute npm or Node.