ishan-cli v0.0.2

Ishan CLI

Ishan CLI is a command-line tool designed to streamline the creation of boilerplate files and modular folder structures for web development projects, adhering to industry standards.

Installation

Ensure you have Node.js and npm (Node Package Manager) installed on your machine. Then, run Ishan CLI commands using npx, pnpm dlx, or bunx without installing it globally:

npx ishan-cli init
npx ishan-cli create --name=<module-name>

Replace <module-name> with your desired module name.

Usage

Ishan CLI provides commands to generate boilerplate files and modular folder structures for different frontend frameworks.

Commands

Initialize Project Configuration

Initialize a new project with configuration settings such as project type, module folder path, CSS framework, and more.

npx ishan-cli init

Options:

• -p, --project-type <type>: Specify the type of project (e.g. next-app, next-page, react).
• -m, --module-folder <path>: Set the path for the module folder.
• -c, --css-framework <framework>: Choose the CSS framework to use. (e.g. @emotion/css, tailwind)
• --use-shadcn: Enable Shadcn integration.
• -l, --libs-path <path>: Set the default path for libraries.
• -u, --util-path <path>: Set the default path for utility.
• -r, --config-path <path>: Set the default path for config.

Example:

npx ishan-cli init --project-type=next --module-folder=./src/modules --css-framework=@emotion/css --use-shadcn

This command will initialize a new project configuration and save it to ishan.json.

Create Frontend Module

Create a new module or submodule based on the existing configuration.

npx ishan-cli create --name=<module-name>

Options:

• -n, --name <name>: Specify the name of the module or submodule.

Example:

npx ishan-cli create --name=my-module

This command will create a module or submodule using the configuration saved in ishan.json.

Features

• Modular Folder Structure: Organize your frontend projects with a modular folder structure optimized for maintainability and scalability.
• Boilerplate Files: Quickly generate boilerplate files such as React components, API utilities, CSS modules, and more to jumpstart your development.

Coming Soon

• Create Backend Module: Generate backend modules with predefined files and folder structures for backend frameworks.
• Add Frontend Dependencies: Install standard frontend dependencies and initialize project configurations.
• Add Backend Dependencies: Install standard backend dependencies and initialize project configurations.

Stay tuned for these features! Contributions and feedback are always welcome.

Contributing

Contributions are welcome! If you have any suggestions, feature requests, or find any issues with Ishan CLI, please feel free to create an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Get Started

Ready to dive in? Follow our Getting Started Guide to set up your first project with Ishan CLI.