react-cli-setup

1.0.12Β β€’Β PublicΒ β€’Β Published

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: upadhayaynitesh@gmail.com
🌐 GitHub: https://github.com/Niteshcodes/


Happy coding! πŸš€

Package Sidebar

Install

npm i react-cli-setup

Weekly Downloads

9

Version

1.0.12

License

MIT

Unpacked Size

7.43 kB

Total Files

3

Last publish

Collaborators

  • nitesh-upadhayay