Skip to content

byte-blade-coder/npm-react-auto-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

React Auto Maker πŸš€

This is a CLI tool to automatically create and configure React projects using Vite.
It helps you set up folders, Axios, React Router, TailwindCSS with just a few prompts.


πŸ“¦ Installation

  1. Clone the repository: git clone https://github.com/byte-blade-coder/npm-react-auto-tool.git

  2. Navigate to the project folder: cd npm-react-auto-tool

  3. Install dependencies (if needed): npm install

  4. Link the tool globally (so you can run it anywhere): npm link


⚑ Usage

After linking, you can run the tool using:

make-react


πŸ›  Features

  • Creates a new Vite React project.
  • Automatically generates src/pages and src/components folders.
  • Optionally installs:
    • Axios
    • React Router DOM (with auto AppRoutes.jsx setup)
    • Tailwind CSS (with config + Mughal Zaada πŸ‘‘ homepage design)
  • Cleans up default files for a ready-to-use project.

πŸ“‚ Project Structure (Example)

my-app/ β”œβ”€β”€ src/ β”‚ β”œβ”€β”€ components/ β”‚ β”œβ”€β”€ pages/ β”‚ β”‚ └── Home.jsx β”‚ β”œβ”€β”€ routes/ β”‚ β”‚ └── AppRoutes.jsx β”‚ β”œβ”€β”€ App.jsx β”‚ β”œβ”€β”€ main.jsx β”‚ └── index.css β”œβ”€β”€ package.json


βœ… Example Flow

  1. Run the command:

    make-react

  2. Answer prompts:

    • Enter project name
    • Install Axios? (y/n)
    • Install React Router DOM? (y/n)
    • Install Tailwind CSS? (y/n)
  3. Done πŸŽ‰ Your project is ready and dev server will auto start.


πŸ”— Notes

  • Node.js v18+ is required.
  • If you face permission issues with npm link, try running with Admin/Root rights.

πŸ‘‘ Developed with love by Mughal Zaada

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published