create-next-heroui-kit

Create a Next.js app with HeroUI pre-integrated — zero config.

One command, a fresh Next.js project, Tailwind CSS v4 configured, HeroUI + framer-motion installed, providers wired up, and optional state management + pre-commit hooks out of the box.

Usage

npx create-next-heroui-kit@latest

Or pass a name directly:

npx create-next-heroui-kit my-app

What it does

1. Scaffolds a fresh Next.js app via create-next-app@latest (App Router, Tailwind, Turbopack).
2. Installs @heroui/styles, @heroui/react, and next-themes.
3. Adds @import "@heroui/styles" and a dark Tailwind v4 custom variant to globals.css.
4. Creates a providers.tsx with next-themes ThemeProvider and patches layout to use it (with suppressHydrationWarning).
5. Optionally adds state management — Redux Toolkit (default) or Zustand, with a sample store. Redux is composed into the same <Providers> wrapper.
6. (Optional) Sets up Husky + lint-staged + Prettier with a pre-commit hook that runs eslint --fix and prettier --write on staged files.

You skip the "install Next → read HeroUI docs → edit Tailwind config → wire providers" ritual.

Options

Flag	Description
-y, --yes	Skip prompts, use sensible defaults
--ts / --js	TypeScript (default) or JavaScript
--npm / --pnpm / --yarn / --bun	Pick your package manager
--no-husky	Skip Husky + lint-staged setup
--state=<lib>	redux (default), zustand, none
-v, --version	Print version
-h, --help	Show help

Examples

# Fully interactive
npx create-next-heroui-kit

# Non-interactive with defaults
npx create-next-heroui-kit my-app --yes

# Use pnpm
npx create-next-heroui-kit my-app --pnpm

Requirements

• Node.js 20+ (Next.js 16 requires it)
• Network access (to fetch create-next-app and HeroUI packages)
• Works with npm, pnpm, yarn, bun. All are tested end-to-end.

Development

git clone https://github.com/NikunjSonigara/create-next-heroui-kit.git
cd create-next-heroui-kit
npm install
node bin/index.js test-app --yes

Contributing

Issues and PRs welcome at github.com/NikunjSonigara/create-next-heroui-kit.

License

MIT