zenith-gen
v1.0.5
Published
A CLI tool designed to streamline the creation of projects within the Zenith Inova ecosystem, providing optimized configurations and modern development tools.
Downloads
23
Maintainers
Readme
Zenith Gen 🚀
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:
npm install -g zenith-gen@latestOr run it directly with npx:
npx zenith-gen@latest🚀 Usage
To generate a new project within the Zenith ecosystem, simply run:
zenith-genOr, if you prefer the default configuration:
zenith-gen --defaultThe 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
🤝 Contributing
Contributions are welcome! Feel free to open issues and pull requests.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
