UNPKG

ganjineh

Version:

A command-line interface (CLI) tool for scaffolding new projects with various languages and frameworks.

58 lines (37 loc) 2.93 kB
# ganjineh-cli A powerful and intuitive Command-Line Interface (CLI) tool designed to streamline the process of scaffolding new projects. `ganjineh-cli` helps developers quickly set up diverse project structures for various programming languages and frameworks, accelerating development cycles. ## Features `ganjineh-cli` supports project creation across multiple domains, including web development (frontend and backend) and cross-platform mobile development. Here's a breakdown of the supported technologies: ### Node.js Projects - **Express.js:** A minimal and flexible Node.js web application framework. - **React (CRA):** A popular JavaScript library for building user interfaces (using Create React App). - **Vite (React):** A next-generation frontend tooling that provides an extremely fast development experience for React projects. - **Next.js:** A React framework for building server-side rendered (SSR) and static web applications. - **NestJS:** A progressive Node.js framework for building efficient, reliable and scalable server-side applications. - **Fastify:** A fast and low-overhead web framework for Node.js. ### Python Projects - **Django:** A high-level Python web framework that encourages rapid development and clean, pragmatic design. - **Flask:** A lightweight WSGI web application framework for Python. - **FastAPI:** A modern, fast (high-performance) web framework for building APIs with Python 3.7+ based on standard Python type hints. ### Mobile (Cross-platform) Projects - **React Native:** A framework for building native mobile apps using React. - **Flutter:** Google's UI toolkit for building natively compiled applications for mobile, web, and desktop from a single codebase. ## Installation To install `ganjineh-cli` globally on your system, open your terminal and run the following command: ```bash npm install -g ganjineh-cli ``` ## Usage Once installed, you can use `ganjineh-cli` from any directory. Simply run the `ganjineh` command, and follow the interactive prompts to configure your new project: ```bash ganjineh ``` The CLI will guide you through selecting your desired programming language, framework/tool, project name, license, and other options. ## Getting Started with Your New Project After `ganjineh-cli` successfully creates your project, navigate into the new project directory. Each generated project comes with its own `README.md` file containing specific instructions on how to install dependencies and run your newly created application. ## Contribution Guidelines We welcome contributions to `ganjineh-cli`! Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for detailed guidelines on how to contribute. ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. ## Author [Ganjineh](https://github.com/Ganjineh-Directory)