# express-cli-helper

> express CLI tool for generating an express api project. Instead of wasting extra time creating your project structure, start building right away

Latest version **1.0.7** (published 2023-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install express-cli-helper
pnpm add express-cli-helper
yarn add express-cli-helper
bun add express-cli-helper
```

Provides the command `exp-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2023-05-10 |
| First published | 2023-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 104.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | mohamed-khaled |
| Maintainers | devmohamedkh |
| Keywords | express, api, cli, express-cli, node |

## Links

- npm: https://www.npmjs.com/package/express-cli-helper
- Repository: https://github.com/devmohamedkh/express-cli
- Homepage: https://github.com/devmohamedkh/express-cli#readme
- Issues: https://github.com/devmohamedkh/express-cli/issues
- npm.io page: https://npm.io/package/express-cli-helper

## Dependencies (5)

- [ora](https://npm.io/package/ora.md) ^5.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^15.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2023-05-10
- 1.0.6 — 2023-05-10
- 1.0.4 — 2023-04-25
- 1.0.3 — 2023-04-19
- 1.0.2 — 2023-04-19
- 1.0.1 — 2023-04-16
- 1.0.0 — 2023-04-16

## README

---

## About

express cli helper is a command-line interface tool that helps you to generates an express project
structure pre-configured with the most commonly used packages to speed up your development workflow.
Instead of wasting time setting up your project structure, express-cli-helper does the heavy lifting
FOR YOU with best-practice architectural patterns to encourage well-structured apps.

## Installation

**npm install -g express-cli-helper**

## Features

- Preconfigured database driver (Mongoose and Sequelize)
- Typescript support
- Generate Models, Controllers, Routes, Services and Test files directly from the command
- Easy exception handling
- Beautiful clear code structure
- Integrated Testing tool
- Eslint and Prettier Formatting
- Integrated Basic Security e.t.c

## Quick Start

1.  Install the package globally **npm install -g express-cli-helper**
2.  Open your command line tool and type the following command to create a new project **exp-cli
    create project-name** _Subsitute "project-name" with the name of your project._

3.  Select your preferred language (Javascript or Typescript) and Database Driver (Mongoose or
    Sequelize)
4.  Once project is installed, configure your environment variables

## Commands

| Commands                |                                      Description                                      |                     Example |
| ----------------------- | :-----------------------------------------------------------------------------------: | --------------------------: |
| create                  |                                 Creates a new project                                 | exp-cli create project-name |
| -m or --model           |                       Create a new model in the model directory                       |             exp-cli -m post |
| -c or --controller      |                  Create a new controller in the controller directory                  |             exp-cli -c post |
| -s or --service         |                     Create a new service in the service directory                     |             exp-cli -s post |
| -r or --route           |                       Create a new route in the route directory                       |             exp-cli -r post |
| -R or --resource        |   Create a new route, model, controller and service in their respective directories   |             exp-cli -R post |
| -u or --utility         |                   Create a new utility file in the utils directory                    |    exp-cli -u random-string |
| -M or --middleware      |                  Create a new middleware in the middleware directory                  |             exp-cli -M auth |
| -V or --validator       |                Create a new validator file in the validator directory                 |   exp-cli -v user-validator |
| -v or --version         |                            Get express-cli-helper version                             |                  exp-cli -v |
| -i or --interface       | Create a new interface file in the interface directory (Available only on Typescript) |             exp-cli -i post |
| -U or --unittest        |                   Create a new unit test file in the test directory                   |             exp-cli -U post |
| -I or --integrationtest |               Create a new integration test file in the test directory                |             exp-cli -I post |
| -T or --test            |                         Create new unit and integration test                          |             exp-cli -U post |
| -C or --config          |                   Create a new config file in the config directory                    |             exp-cli -C mail |

---
_Source: https://npm.io/package/express-cli-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._