Generate pre-configured React apps with your choice of framework, styling, and tooling

---

Table of Contents

• Demo
• Quick Start
• What It Does
• Quick Examples
• Installation
• CLI Reference
• Community & Support
• Contributing
• License

---

Demo

react-kickstart-demo.mov

Interactive CLI demonstration

---

Quick Start

No installation needed. Just run with npx:

npx @gavbarosee/react-kickstart my-app
# or with yarn
yarn create @gavbarosee/react-kickstart my-app

You'll answer a few prompts to configure your stack. Takes less than a minute.

Prefer global installation? Install once and use the shorter command:

npm install -g @gavbarosee/react-kickstart
# or
yarn global add @gavbarosee/react-kickstart

# Then run
react-kickstart my-app

Requirements: Node.js 18 or later

---

What It Does

Tools like create-vite and create-next-app give you a framework with minimal setup. React Kickstart scaffolds your entire application stack:

• State management — Redux or Zustand configured with working examples
• Routing — React Router or Next.js routing set up with example pages
• API integration — Axios or fetch with React Query configured and ready
• Testing — Vitest or Jest set up with example tests
• Styling — Tailwind CSS, styled-components, or CSS properly configured
• Deployment — Vercel or Netlify configurations included
• Code quality — ESLint and Prettier preconfigured

Everything works together out of the box. No configuration required.

How It Works

1. Sets up your project — Creates folders and base files
2. Adds your choices — Framework, styling, state management, and tooling (see options)
3. Installs dependencies — Runs npm or yarn automatically (auto-detects which you're using)
4. Configures everything — ESLint, Prettier, TypeScript, testing—all wired together
5. Generates working code — Example components showing how everything fits together
6. Opens your editor — Detects VS Code or Cursor and launches it automatically
7. Starts the dev server — Opens localhost:5173 (Vite) or :3000 (Next.js) in your browser

Stack Options

Category	Options
Framework	Vite, Next.js (app/pages router)
Language	TypeScript, JavaScript
Styling	Tailwind CSS, styled-components, CSS
Routing	React Router, Next.js built-in
State	Redux Toolkit, Zustand, none
API	Axios + React Query, Fetch + React Query, basic setups
Testing	Vitest, Jest, none
Deployment	Vercel, Netlify, manual
Package Manager	npm, yarn (auto-detected)
Git	Initialize repository (yes/no)
Linting	ESLint + Prettier (yes/no)
Editor	Cursor, VS Code, none (auto-detects installed editors)

---

Quick Examples

Quick & Simple:

npx @gavbarosee/react-kickstart my-app --yes

Good for quick prototypes. Vite with sensible defaults.

Production Ready:

npx @gavbarosee/react-kickstart my-app \
  --framework nextjs \
  --typescript \
  --styling tailwind \
  --state redux \
  --api axios-react-query \
  --testing jest \
  --deployment vercel

Everything you need to start building a real application.

---

Installation

Use npx (no installation needed) or install globally if you'll use it often. See the full installation guide for more details.

---

CLI Reference

Available Flags

Flag	Options	Default	Description
-y, --yes	-	false	Skip prompts, use defaults
-f, --framework	vite, nextjs	vite	React framework
--typescript	-	false	Enable TypeScript
--styling	tailwind, styled-components, css	tailwind	Styling solution
--state	redux, zustand, none	none	State management
--api	axios-react-query, fetch-only, none	none	API integration
--testing	vitest, jest, none	none	Testing framework
--deployment	vercel, netlify, none	none	Deployment platform

Complete CLI Reference — Full documentation with all options and examples

---

Community & Support

Need help?

• GitHub Discussions — Ask questions and share ideas
• GitHub Issues — Report bugs and request features
• Documentation — Guides and references

Stay in the loop:

• GitHub Releases — New versions and updates
• Changelog — What's changed in each version

---

Contributing

See the contributing guide for setup and workflow details.

Contributors

---

License

MIT — see the LICENSE file for details.

Copyright © 2025 Gav Barosee