Package Exports
- @gavbarosee/react-kickstart
- @gavbarosee/react-kickstart/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@gavbarosee/react-kickstart) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Table of Contents
- Demo
- Quick Start
- What It Does
- Quick Examples
- Installation
- CLI Reference
- Community & Support
- Contributing
- License
Demo
https://github.com/user-attachments/assets/cd32c723-63f7-4b6f-81b9-abed53477318
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 be asked a few questions to configure your stack. Typically under a minute.
Prefer global installation? Install once and use the shorter command:
npm install -g @gavbarosee/react-kickstart
# or with yarn
yarn global add @gavbarosee/react-kickstart
# then run
react-kickstart my-app
Requirements: Node.js >= 18
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 with no configuration required.
How It Works
- Sets up your project — Creates folders and base files
- Adds your choices — Framework, styling, state management, and tooling (see options)
- Installs dependencies — Runs npm or yarn automatically (auto-detects which you use)
- Configures everything — ESLint, Prettier, TypeScript, testing—all wired together
- Generates working code — Example components showing how everything fits together
- Opens your editor — Detects VS Code or Cursor and launches it
- Starts the dev server — Opens
localhost:3000
(Vite) or:3001
(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 Quick Start above.
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 contributor guide for detailed setup and workflow.
Contributors
License
This project is licensed under the MIT License - see the LICENSE file for details.
Copyright (c) 2025 Gav Barosee