feature-hub/readme.md

Feature-based CLI tool to install backend features easily like auth, cron-job, file-upload, etc.

---
# 📦 feature-hub

A simple CLI tool to quickly install ready-made features (like auth, cron-jobs, payment, file-upload, etc.) into your Node.js projects 🚀

---

## ✨ Features
- Install prebuilt feature templates into your project
- Auto install required npm packages
- Auto update your `.env` file with necessary environment variables
- Supports **npm**, **yarn**, and **pnpm** package managers
- Easy and fast to use

---

## 🛠️ Installation

```bash
# Install globally
npm install -g feature-hub
```

or you can use it directly without installation:

```bash
npx feature-hub
```

---

## ⚡️ Usage

### Install a feature into your project

```bash
feature-hub install <feature-name>
```
or simply
```bash
feature-hub i <feature-name>
```

You will be asked **where** you want to install the feature.  
Just provide the folder path (example: `src/features`) and it will be installed there ✅

---

## 📜 Example

### Install `auth` feature

```bash
feature-hub i auth
```

OR with `npx`:

```bash
npx feature-hub i auth
```

You will see:

```
✅ Where do you want to install "auth"? Provide the path:
> src/features
```

Done!  
It will:
- Copy the `auth` folder
- Install all required npm packages
- Add environment variables to `.env` file

---

## 📚 Available Features

| Feature Name | Description          |
|--------------|-----------------------|
| `auth`       | Authentication system  |
| `cron-job`   | Cron job scheduling     |
| `file-upload`| File upload handling   |
| `payment`    | Payment system         |
| `queue`      | Queue system setup     |
| `redis`      | Redis setup            |
| `payments`   | Payment integration    |

(✅ More features coming soon...)

---

## 🔥 Commands Quick Reference

| Command | Description |
|---------|-------------|
| `feature-hub install <feature>` | Install a feature |
| `feature-hub i <feature>`        | Short version to install |
| `npx feature-hub i <feature>`    | Use directly without installing globally |

---

## ⚡ Example Session

```bash
npx feature-hub i auth

✅ Where do you want to install "auth"? Provide the path:
> src/modules

✅ Successfully installed "auth" at /your/project/src/modules/auth
✅ Required packages installed by npm
```

---

## 👌 Contribution

Feel free to open an issue or submit a pull request if you want to improve this CLI tool!

---

## 📔 License

MIT License

---

# 🚀 Happy Coding with Feature Hub!



---