Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 React Setup CLI

A simple interactive CLI tool to quickly scaffold a Vite + React project with TypeScript/JavaScript, state management, Tailwind CSS, shadcn/ui, and more — all pre-configured.

✨ Features

  • 🛠️ Create a new React + Vite project in seconds
  • 📦 Supports JavaScript and TypeScript templates
  • ⚛️ Choose your state management: Recoil, Redux Toolkit, Zustand, or none
  • 🎨 Tailwind CSS automatically configured with Vite plugin
  • 🧩 Optional shadcn/ui setup with @ path alias pre-configured
  • 🔌 Optional Socket.IO client
  • 🗂️ Optional Git initialization with an initial commit
  • 📦 Installs commonly used dependencies:

🖥️ Usage

Run directly with npm create:

npm create react-boot@latest

Example Walkthrough

Welcome to React Setup CLI!

? Enter the project name ( Enter . for current directory ) : my-app
? Select the language:
  ▸ TypeScript
    JavaScript
? Initialize a git repository? (Y/n)
? Select the state management:
  ▸ None
    Recoil
    Redux
    Zustand
? Would you like to add shadcn/ui? (y/N)
? Would you like to use Socket.IO? (y/N)

It will:

  1. Scaffold a new Vite + React project
  2. Install selected dependencies
  3. Configure Tailwind CSS automatically
  4. Set up shadcn/ui with path aliases (if selected)
  5. Initialize a Git repository with an initial commit (if selected)
  6. Get you ready to code 🚀

📂 Project Structure

After running the CLI, you'll get a standard Vite + React project with everything ready to use:

my-app
├── src
│   ├── App.tsx / App.jsx
│   ├── main.tsx / main.jsx
│   └── index.css
├── vite.config.ts / vite.config.js
├── tsconfig.json          (TypeScript only)
├── tsconfig.app.json      (TypeScript only)
└── package.json

If shadcn/ui was selected, the @ alias is configured so you can import like:

import { Button } from "@/components/ui/button"

🚦 Run Your App

After setup is complete:

cd my-app
npm run dev

Or, if you chose . for the current directory:

npm run dev

🤝 Contributing

PRs are welcome! If you'd like to add features or fix issues, please open an issue first to discuss your idea.


📄 License

This project is licensed under the MIT License. See the LICENSE file for details.


Made with ❤️ by Dibakar

About

A CLI tool to quickly bootstrap a Vite + React project with TypeScript/JavaScript, Tailwind CSS, and optional state management (Redux, Recoil, Zustand) — run via npm create react-boot@latest

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages