Getting Started
Installation

Installation

React Kickstart can be used in multiple ways depending on your workflow preferences. Choose the method that works best for you.

Prerequisites

Node.js

Ensure you have Node.js 16 or higher installed on your system.

node --version
# Should output v16.0.0 or higher

Package Manager

React Kickstart works with both npm and yarn. It will auto-detect your preferred package manager.

Git (Optional)

While not required, Git is recommended for version control of your generated projects.


Installation Methods

NPX - No Installation Required

The easiest way to use React Kickstart is with npx, which runs the latest version without installing anything globally.

npx @gavbarosee/react-kickstart my-app

Recommended approach - Always uses the latest version and doesn't clutter your global packages.


Verify Installation

To verify that React Kickstart is working correctly, you can check the version:

npx @gavbarosee/react-kickstart --version

You should see output similar to:

@gavbarosee/react-kickstart v0.4.0

System Requirements

RequirementMinimumRecommended
Node.jsv16.0.0v18.0.0+
npmv7.0.0v9.0.0+
Memory512MB1GB+
Disk Space100MB500MB+

Platform Support: React Kickstart works on macOS, Linux, and Windows. Windows users should use PowerShell or Git Bash for the best experience.


Next Steps

Now that you have React Kickstart installed, you're ready to create your first project!