react-starter-plus/README.md

react-starter-plus a react starter template

# React Starter Plus

Scaffold modern React apps with Vite, Tailwind CSS, and optional features like TypeScript, Zustand, Testing, CI/CD, and Vercel deployment — in minutes.

## ⚡ Quick Start

### Installation

```bash
npx react-starter-plus
```

### Usage

Run the CLI and follow prompts:

```bash
npx react-starter-plus
```

## Features

- **Vite + React** – Fast dev server with HMR
- **Tailwind CSS** – Utility-first styling
- **TypeScript** – Full config & type safety (optional)
- **Zustand** – Lightweight state management (optional)
- **Testing** – Jest + React Testing Library (optional)
- **CI/CD** – GitHub Actions workflow (optional)
- **Vercel** – One-click deployment setup (optional)
- **Clean Architecture** – Organized folder structure & routing

Prompts include:

1. Project name
2. Language (JavaScript / TypeScript)
3. Git setup & remote repo (optional)
4. CI/CD (optional)
5. Zustand store (optional)
6. Testing setup (optional)
7. Vercel deployment config (optional)

## What's Included

- **Base:** Vite, React 19, Tailwind CSS, React Router, ESLint & Prettier, clean folder structure
- **Optional:**

  - TypeScript – Full config & ESLint integration
  - Zustand – TS support & sample store
  - Testing – Jest + RTL with examples
  - CI/CD – GitHub Actions for testing & linting
  - Styling – Dark mode, custom colors, responsive utilities
  - Vercel – CLI integration & ready deployment setup

## Project Structure

```
my-react-app/
├── src/          # Components, hooks, routes, store, utils
├── public/       # Static assets
├── config files  # Tailwind, ESLint, Prettier, Vite
└── package.json
```

## Available Scripts

```bash
npm run dev       # Start dev server
npm run build     # Build for production
npm run preview   # Preview build locally
```

## Configuration

- **Vite** – React, Tailwind, `@/` alias
- **Tailwind** – Dark mode, custom colors, responsive breakpoints
- **ESLint & Prettier** – React best practices, TypeScript (if enabled), consistent formatting

## Requirements

- Node.js 16+
- npm or yarn
- Git (for repo features)
- Vercel CLI (for deployment)

## Deployment

If Vercel deployment is enabled:

```bash
vercel --prod   # Deploy to production
vercel          # Deploy preview
```

More in [Vercel Docs](https://vercel.com/docs).

---

Made with 💌 by [Abhishek Jha](https://github.com/iCoderabhishek)
**Happy koding ;)**

---