React Setup CLI 🚀

A CLI tool to quickly set up a React project with pre-configured templates like ShadCN, Redux, and more.

📌 Why Use React Setup CLI?

• ⚡ Instant Project Setup – Get a fully configured React project in seconds.
• 🎨 Pre-built Templates – Includes ShadCN, Redux, and more.
• 🏠 Best Practices – Organized structure with ready-to-use configurations.
• 🔥 GitHub-Hosted Templates – Clones the latest templates directly.

🔥 Installation

To install globally:

npm i -g react-cli-setup

If react-setup is not recognized, try running with npx:

npx react-setup init --shadcn --name my-app

Also, ensure the global binaries path is added to your system's Environment Variables.

🚀 Usage

To create a new React project, run:

react-setup init --shadcn --name my-app

or with Redux:

react-setup init --shadcn-redux --name my-app

This will: ✅ Clone the selected template from GitHub
✅ Create a new folder with the specified name
✅ Guide you to the next steps

🌜 Available Commands

react-setup init

Initialize a new React project.

| Option | Description | | ---------------- | ------------------------------------------------------- | | --shadcn | Clone the ShadCN-based React project | | --shadcn-redux | Clone the ShadCN-based React project with Redux | | --electron | Clone the ShadCN-based React project with electron | | --name <name> | Set a custom project name (default: my-react-project) |

Example:

react-setup init --shadcn --name my-awesome-app

🏢 Project Structure

Once initialized, your project will have:

my-app/
️📂 src/
   👉 components/
   👉 pages/
   👉 store/
   👉 assets/
   👉 routes/
   👉 main.tsx
️📂 public/
️📂 package.json
️📂 tsconfig.json
️📂 vite.config.ts
️📂 README.md

🛠 Next Steps

After cloning, navigate into the project and start:

cd my-app
npm install
npm run dev

🐝 License

This project is licensed under the MIT License.

🤝 Contributing

Contributions are welcome! Open an issue or submit a PR.

👨‍💻 Author

Nitesh
📧 Email: [email protected]
🌐 GitHub: https://github.com/Niteshcodes/

Happy coding! 🚀