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
A modern CLI tool for creating React applications with your preferred framework and stack
From idea to running app in seconds • Zero configuration • Production-ready • Your stack, your choice
Table of Contents
- Demo
- Quick Start
- What React Kickstart Does
- Why Not Just Use Vite or Next.js CLI?
- Prerequisites
- Installation
- Usage Examples
- CLI Reference
- Documentation
- Quality Assurance
- Community & Support
- Contributing
- Changelog
- License
Demo
https://github.com/user-attachments/assets/3e2e935f-4f29-4445-8f25-3fd93bc5d440
The CLI's interactive mode in action!
Quick Start
New: Now with enhanced semantic release automation!
# Interactive mode (guided prompts)
npx @gavbarosee/react-kickstart my-app
# Non-interactive mode (with flags)
npx @gavbarosee/react-kickstart my-app \
--yes \
--framework vite \
--typescript \
--styling tailwind \
--routing react-router \
--state redux \
--api axios-react-query \
--testing vitest \
--deployment netlify
What React Kickstart Does
React Kickstart creates a complete, working React application in seconds. Here's exactly what happens when you run it:
The Complete Setup Process
- Asks you simple questions - What framework? TypeScript? Styling? State Management? Routing? Tests? Linting? Deployment? etc (or skip for a default configuration with
--yes
) - Creates your project folder with a clean file structure
- Installs all dependencies automatically (npm/yarn) - no manual setup needed
- Configures everything - ESLint, Prettier, build scripts, deployment settings
- Generates example code showing how to use your chosen tools together
- Opens your IDE automatically (VS Code, Cursor, etc.) if installed
- Starts the dev server and opens your browser to
localhost
- Ready to code! - Your app is running and you can start building immediately
What Makes It Special
- Zero configuration - Everything just works out of the box
- Smart detection - Finds your installed IDE and package manager
- Battle-tested combinations - All tools are pre-configured to work together perfectly
- Real examples - Not empty templates, but working code you can build on
- Production ready - Includes deployment configs, testing setup, and best practices
Technology Options
Choose Your Stack | Available Options |
---|---|
Framework | Vite (fast dev) or Next.js (full-stack) |
Language | TypeScript (recommended) or JavaScript |
Styling | Tailwind CSS, styled-components, or plain CSS |
Routing | React Router (Vite only), Next.js App Router, or Pages Router |
State Management | Redux Toolkit, Zustand, or none |
API Calls | Axios + React Query, Axios only, Fetch + React Query, Fetch only, or none |
Testing | Vitest (fast), Jest (traditional), or none |
Deployment | Vercel, Netlify, or manual setup |
Package Manager | npm or yarn (auto-detected) |
Why Not Just Use Vite or Next.js CLI?
Great question! The official tools (npm create vite@latest
, npx create-next-app
) are excellent, but they only get you started. React Kickstart goes much further:
Official CLI Tools Give You:
- Basic project structure
- Minimal configuration
- A "Hello World" starting point
React Kickstart Gives You:
- Everything above, PLUS:
- Pre-configured tool combinations - Redux + RTK Query, Tailwind + TypeScript, etc.
- Working example code - See how the tools work together, not just empty templates
- Complete development setup - ESLint, Prettier, testing, deployment configs
- Smart integrations - Auto-detects your IDE and package manager
- Production-ready structure - Organized folders, best practices, proper imports
- One command setup - No need to manually add and configure 5+ additional tools
Prerequisites
- Node.js
>= 16
- Required for running the CLI
Installation
NPX (Recommended)
# Run directly without installing
npx @gavbarosee/react-kickstart my-app
# Or with yarn
yarn create @gavbarosee/react-kickstart my-app
Global Install
# Install globally for repeated use
npm install -g @gavbarosee/react-kickstart
react-kickstart my-app
# Or with yarn
yarn global add @gavbarosee/react-kickstart
react-kickstart my-app
Usage Examples
# Interactive mode (recommended for beginners)
npx @gavbarosee/react-kickstart my-app
# Quick start with defaults
npx @gavbarosee/react-kickstart my-app --yes
# Full-featured setup
npx @gavbarosee/react-kickstart my-app --yes --framework nextjs --typescript --styling tailwind --state redux --api axios-react-query --testing jest --deployment vercel
CLI Reference
Key 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 |
Quick Examples
# Interactive mode (recommended)
npx @gavbarosee/react-kickstart my-app
# Quick start with defaults
npx @gavbarosee/react-kickstart my-app --yes
# Full-featured setup
npx @gavbarosee/react-kickstart my-app --yes --framework nextjs --typescript --styling tailwind --state redux --api axios-react-query --testing jest --deployment vercel
Complete CLI Reference → - All flags, examples, and usage patterns
Documentation
For Users
Getting Started → - Installation, first project, and basic usage
CLI Reference → - Complete command and flag documentation
Troubleshooting → - Common issues and solutions
For Contributors
Contributor Guide → - Setup, workflow, and requirements
Architecture Overview → - How React Kickstart works internally
Extending React Kickstart → - Add frameworks, styling, testing options
Quality Assurance → - Testing and validation systems
Quality Assurance
React Kickstart includes comprehensive quality assurance systems to ensure reliability:
- Automated Testing - Unit tests, integration tests, and end-to-end validation
- Feature Validation - Automated testing of all framework/tool combinations
- Flag Validation - CLI flag compatibility and error handling tests
- QA Reports - Detailed test reports for every build and release
QA Documentation → - Complete testing and validation systems
Community & Support
Getting Help
- GitHub Discussions - Ask questions, share ideas, and get community support
- GitHub Issues - Report bugs and request features
- Documentation - Comprehensive guides and API reference
Stay Updated
- GitHub Releases - Latest versions and release notes
- Changelog - Detailed version history and breaking changes
- Roadmap - Upcoming features and improvements
Community Guidelines
- Be respectful and constructive in all interactions
- Search existing issues before creating new ones
- Provide clear reproduction steps for bug reports
- Follow the contribution guidelines for pull requests
Contributing
Contributions welcome! All changes go through pull requests with automated testing and QA validation.
See the Documentation section above for contributor guides and setup instructions.
Ways to Contribute
Type | Examples |
---|---|
Code | Features, bug fixes, refactoring |
Documentation | Guides, examples, README improvements |
Testing | QA improvements, test coverage |
Design | UI/UX improvements, logos, assets |
Ideas | Feature requests, architecture discussions |
Contributors
Become a contributor → - Setup guide and contribution workflow
Changelog
Current Version: 0.1.0 - Initial release with Vite/Next.js, TypeScript, Tailwind, Redux, testing, and deployment support.
Full Changelog → - Complete version history and release notes
Project Health & Maintenance
This project is actively maintained with automated testing, security monitoring, and regular updates:
Deployment & Operations
- Automated Release Setup - Semantic versioning, npm publishing, GitHub releases
- Nightly Operations - Automated validation, security checks, performance monitoring
- CI/CD Setup - Continuous integration examples and best practices
Quality Assurance
- Matrix Testing: Comprehensive validation across all framework/feature combinations
- Automated QA: Real project generation and validation (not mocks)
- Release Protection: Version changes require full matrix validation before publishing
- Community Support: Issues responded to within 48 hours
License
This project is licensed under the MIT License - see the LICENSE file for details.
Copyright (c) 2025 Gav Barosee