create-jazz-app
TypeScript icon, indicating that this package has built-in type declarations

0.1.16Β β€’Β PublicΒ β€’Β Published

Create Jazz App

🎷 A modern CLI tool to scaffold Jazz applications with your favorite framework and authentication method.

Features

  • πŸš€ Quick start with popular frameworks (React, Vue, Svelte, Next.js, React Native)
  • πŸ” Multiple authentication options (Demo, Passkey, Clerk, etc.)
  • πŸ“¦ Support for various package managers (npm, yarn, pnpm, bun, deno)
  • πŸ’… Beautiful CLI interface with interactive prompts
  • ⚑️ Zero-config setup process

Usage

You can create a new Jazz app in two ways:

Interactive mode

Simply run:

npx create-jazz-app@latest

Then follow the interactive prompts to select your:

  • Framework and authentication combination
  • Package manager
  • Project name

Command line mode

Or specify all options directly:

npx create-jazz-app@latest my-app --starter react-demo-auth --package-manager npm

Start with an example app

You can use any of our example apps as a template for your own app, instead of choosing one of the starters.

Use the --example parameter, and pass the directory name of the example app found here.

npm create jazz-app@latest --example chat

Available starters

Currently implemented starters:

  • react-demo-auth - React + Jazz + Demo Auth
  • react-passkey-auth - React + Jazz + Passkey Auth
  • react-clerk-auth - React + Jazz + Clerk Auth
  • vue-demo-auth - Vue + Jazz + Demo Auth
  • svelte-passkey-auth - Svelte + Jazz + Passkey Auth
  • nextjs-demo-auth - Next.js + Jazz + Demo Auth
  • react-native-expo-clerk-auth - React Native Expo + Jazz + Clerk Auth

More starters coming soon! Check the help menu (create-jazz-app --help) for the latest list.

System requirements

  • Node.js 14.0.0 or later
  • Package manager of your choice (npm, yarn, pnpm, bun, or deno)

What happens when you run it?

  1. 🎭 Prompts for your preferences (or uses command line arguments)
  2. πŸ“₯ Clones the appropriate starter template
  3. πŸ“¦ Updates dependencies to their latest versions
  4. βš™οΈ Installs all required packages
  5. πŸŽ‰ Sets up your project and provides next steps

License

MIT


Made with β™₯️ by the Jazz team

Readme

Keywords

none

Package Sidebar

Install

npm i create-jazz-app

Weekly Downloads

90

Version

0.1.16

License

MIT

Unpacked Size

64.1 kB

Total Files

12

Last publish

Collaborators

  • pax-k
  • anselm_io