create-kalp-boilerplate/README.md

A Kalp CLI tool to generate a React boilerplate

# create-kalp-boilerplate

## 🚀 Introduction
`create-kalp-boilerplate` is a CLI tool that helps you quickly generate a React boilerplate with optional authentication and microfrontend configurations.

## 📦 Installation
Install the package globally using npm:

```sh
npm install -g create-kalp-boilerplate
```

## 🛠 Usage
To create a new React application, run:

```sh
create-kalp-boilerplate <app-name>
```

### Options:
| Option           | Description                                   |
|-----------------|-----------------------------------------------|
| `--auth`        | Adds authentication functionality             |
| `--mfd-config`  | Adds configuration for microfrontends        |

### Example:
```sh
create-kalp-boilerplate my-app --auth --mfd-config
```
This will create a React project named `my-app` with authentication and microfrontend configuration.

## 📁 Folder Structure
After running the command, the generated project will have the following structure:
```
my-app/
├── src/
│   ├── components/
│   ├── services/api/axios-instance.ts  # If --auth is used
├── package.json
├── README.md
└── ...
```

## 🔧 Features
✅ Generates a TypeScript-based React boilerplate
✅ Optionally includes authentication setup
✅ Supports microfrontend architecture
✅ Installs dependencies automatically

## 📜 License
This project is licensed under the MIT License.

## 👨‍💻 Author
**Sachin Sharma**

For any issues or feature requests, feel free to open an issue in the [GitHub repository](https://github.com/sachinp2e/react-boilerplate-ts).