@adinet/project-structure-cli

Description

@adinet/project-structure-cli is a command-line interface (CLI) tool to create project structures. It allows you to easily create a new project with specific subfolders or add new applications with predefined folder structures.

Installation

To install the CLI globally, run:

npm install -g @adinet/project-structure-cli

Usage

Creating a New Project

To create a new project with a specific structure, use the following command:

adp new <project-name> --app <app-name>

This will create the following structure:

./<project-name>/<app-name>/
    ├── documents
    ├── server
    ├── client
    └── db

Example

adp new my-project --app my-app

Adding a New App to an Existing Project

To add a new app to an existing project, use the following command:

adp app <app-name>

This will create the following structure in the current directory:

./<app-name>/
    ├── documents
    ├── server
    ├── client
    └── db

Example

adp app my-new-app

Skipping Specific Folders

You can skip creating specific folders using the following options:

• --skip-doc: Skip creating the documents folder
• --skip-db: Skip creating the db folder
• --skip-server: Skip creating the server folder
• --skip-client: Skip creating the client folder

Example

adp new my-project --app my-app --skip-doc --skip-db

This will create the following structure:

./my-project/my-app/
    ├── server
    └── client

Contributing

If you would like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

License

This project is licensed under the MIT License.

Author

Checho