create-flowkit-app

Scaffold a new FlowKit author project — a single-workspace, browser-based UI prototyping app (React 19 + Vite + Tailwind).

Status: this package is not yet published under its real name. To try it today, use the scoped canary rehearsal build instead — see Trying it today below.

Usage

npm create flowkit-app@latest <project-name> [-- --empty]

Example:

npm create flowkit-app@latest my-prototype -- --empty

This scaffolds a new project with:

• flowBook/ — your pages, organized by chapter
• flowStories/ — playback scripts describing step-by-step chapters
• manifest.ts — workspace config (defineConfig)
• lib/ — shared workspace data/components
• vite.config.ts pre-wired with the flowkit/vite plugin

By default the project ships with a playable demo (a splash/welcome intro into a hub of 6 mini-games) so you have real content to explore immediately. Pass --empty for a bare scaffold instead — zero chapters, empty db/simulator stubs, ready for your own content.

Once scaffolded:

cd my-prototype
npm install
npm run dev

Trying it today

The real create-flowkit-app / flowkit package names are reserved but not yet published. A scoped canary build is live on the npm registry for end-to-end testing:

npx @rahil316/create-flowkit-app@latest my-prototype

Check npm view @rahil316/create-flowkit-app dist-tags for the current canary version — it advances on every rehearsal publish and is not a stable release channel.

Learn more

Full platform docs, CLI reference, and architecture: see the FlowKit repository.

License

MIT