zenith-gen/README.md

A CLI tool designed to streamline the creation of projects within the Zenith Inova ecosystem, providing optimized configurations and modern development tools.

# Zenith Gen 🚀

![Zenith Gen CLI](https://img.shields.io/badge/Next.js-optimized-blue) ![Zenith Gen CLI](https://img.shields.io/badge/Storybook-integrated-purple) ![Zenith Gen CLI](https://img.shields.io/badge/ShadCN-ready-green)

**Zenith Gen** is a powerful CLI tool designed to streamline the creation of projects within the **Zenith ecosystem**. It provides an optimized setup with **Next.js**, **Storybook**, **ShadCN**, and essential configurations to boost your development workflow.

## 🎯 Features

- 🏗 **Next.js project setup** with options for TypeScript, ESLint, Prettier, and TurboRepo.
- 📚 **Storybook integration** with customizable settings and Chromatic support.
- 🎨 **ShadCN UI components** for a modern styling approach.
- 🛠 **Automatic configuration of essential files** like `.npmrc`, `.nvmrc`, `.env`, ESLint, and Prettier.
- ⚡ **Dependency installation** and initial Git commit for a fully ready-to-use project.

## 📦 Installation

You can install **Zenith Gen** globally using `npm`, `yarn`, or `pnpm`:

```sh
npm install -g zenith-gen@latest
```

Or run it directly with `npx`:

```sh
npx zenith-gen@latest
```

## 🚀 Usage

To generate a new project within the **Zenith ecosystem**, simply run:

```sh
zenith-gen
```

Or, if you prefer the default configuration:

```sh
zenith-gen --default
```

The CLI will guide you through a series of interactive prompts to configure your project according to your preferences.

## ⚙️ Configuration Options

| Option                | Description                                          | Default |
| --------------------- | ---------------------------------------------------- | ------- |
| **Package Manager**   | Choose between `pnpm`, `npm`, or `yarn`.             | `pnpm`  |
| **Next.js Setup**     | TypeScript, ESLint, Prettier, and TurboRepo support. | ✅      |
| **Storybook**         | Automatically configures Storybook and Chromatic.    | ✅      |
| **ShadCN**            | Adds ShadCN UI components for styling.               | ✅      |
| **Git Configuration** | Initializes Git and makes the first commit.          | ✅      |

## 🛠 Technologies Used

- [Next.js](https://nextjs.org/)
- [Storybook](https://storybook.js.org/)
- [ShadCN](https://ui.shadcn.com/)
- [Chalk](https://www.npmjs.com/package/chalk)
- [Inquirer](https://www.npmjs.com/package/inquirer)
- [fs-extra](https://www.npmjs.com/package/fs-extra)

## 🤝 Contributing

Contributions are welcome! Feel free to open **issues** and **pull requests**.

## 📄 License

This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.