# @ps-cli/express

> Express Boilerplate Boilerplate based upto express-generator

Latest version **2.3.2** (published 2021-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ps-cli/express
pnpm add @ps-cli/express
yarn add @ps-cli/express
bun add @ps-cli/express
```

Provides the commands `pse`, `ps-express`.

## 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 | 2.3.2 |
| Published | 2021-07-10 |
| First published | 2021-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 26.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mustafa Shykh |
| Maintainers | muhammadhamza, usmanfaisal60, mustafashykh |
| Keywords | express, framework, sinatra, web, rest, restful, router, app, api |

## Links

- npm: https://www.npmjs.com/package/@ps-cli/express
- Repository: https://github.com/Phaedra-Solutions/ps-express-generator
- Homepage: https://github.com/Phaedra-Solutions/ps-express-generator#readme
- Issues: https://github.com/Phaedra-Solutions/ps-express-generator/issues
- npm.io page: https://npm.io/package/@ps-cli/express

## Dependencies (12)

- [ora](https://npm.io/package/ora.md) ^5.4.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [commander](https://npm.io/package/commander.md) ^7.2.0
- [await-to-js](https://npm.io/package/await-to-js.md) ^3.0.0
- [cli-welcome](https://npm.io/package/cli-welcome.md) ^2.2.2
- [replace-in-file](https://npm.io/package/replace-in-file.md) ^6.2.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0
- [copy-template-dir](https://npm.io/package/copy-template-dir.md) ^1.4.0
- [cli-handle-unhandled](https://npm.io/package/cli-handle-unhandled.md) ^1.1.1

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 2.3.2 (latest) — 2021-07-10
- 2.3.1 — 2021-06-14
- 2.3.0 — 2021-06-08
- 2.2.0 — 2021-06-05
- 2.1.8 — 2021-06-04
- 2.1.7 — 2021-06-04
- 2.1.6 — 2021-06-04
- 2.1.5 — 2021-06-04
- 2.1.4 — 2021-06-03
- 2.1.3 — 2021-06-03
- 2.1.2 — 2021-06-03
- 2.1.1 — 2021-06-03
- 2.1.0 — 2021-06-03
- 2.0.1 — 2021-06-03
- 2.0.0 — 2021-06-03
- … 7 more at https://npm.io/package/@ps-cli/express/versions

## README

[![Express Logo](https://i.cloudup.com/zfY6lL7eFa-3000x3000.png)](http://expressjs.com/)

[Express'](https://www.npmjs.com/package/express) application generator for Pheadera Solution based on on lib express-generator.

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Linux Build][travis-image]][travis-url]
[![Windows Build][appveyor-image]][appveyor-url]

## Installation

```sh
$ npm install -g @ps-cli/express
```


## Quick Start

The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:

### Create the app:

```bash
$ ps-express new <name>
```
or
```bash
$ pse new <name>
```

Options

```bash
Usage: ps-express new [options] <name>

Generates a new project

Options:
  -i, --install  intsall all dependantcies
  -g, --git      initialize git
  -h, --help     Help in options
```



<b>Install dependencies:</b>

```bash
$ npm install
```

Start your Express.js app at `http://localhost:3000/`:

```bash
$ npm start
```

<b>Adding a route:</b>

```bash
$ pse genrate route <name>
```
or
```bash
$ pse g r <name>
```

<b>Adding a service</b>

```bash
$ pse genrate service <name>
```
or
```bash
$ pse g s <name>
```

<b>Options:</b>

Generate

```bash
Usage: ps-express generate|g [options] [command]

Options:
  -h, --help                Get the help info

Commands:
  route|r [options] <name>  Generate a route
  service|s <name>          Generate a service
  help [command]            display help for command
```

<b>Route</b>

```bash
Usage: ps-express generate route|r [options] <name>

Generate a route

Options:
  -c, --crud  Generates CRUDS as well
  -h, --help  Help in options
```

<b>Service</b>

```bash
Usage: ps-express generate service|s [options] <name>

Generate a service

Options:
  -h, --help  Help in options
```
## Command Line Options

This generator can also be further configured with the following command line flags.

```bash
Usage: ps-express [options] [command]

Gives the verison of CLI

Options:
  -v, --version         Version
  -h, --help            Get the help info

Commands:
  new [options] <name>  Generates a new project
  generate|g
``` 

## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/express-generator.svg
[npm-url]: https://npmjs.org/package/express-generator
[travis-image]: https://img.shields.io/travis/expressjs/generator/master.svg?label=linux
[travis-url]: https://travis-ci.org/expressjs/generator
[appveyor-image]: https://img.shields.io/appveyor/ci/dougwilson/generator/master.svg?label=windows
[appveyor-url]: https://ci.appveyor.com/project/dougwilson/generator
[downloads-image]: https://img.shields.io/npm/dm/express-generator.svg
[downloads-url]: https://npmjs.org/package/express-generator

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