# express-server-cli

> CLI to install express-server-boilerplate

Latest version **1.0.5** (published 2019-08-08) · ISC license · 0 weekly downloads

## Install

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

Provides the command `express-server-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.5 |
| Published | 2019-08-08 |
| First published | 2019-07-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ahsan Khan |
| Maintainers | ahsankhan1911 |
| Keywords | boilerplate, express, server |

## Links

- npm: https://www.npmjs.com/package/express-server-cli
- npm.io page: https://npm.io/package/express-server-cli

## Dependencies (3)

- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.0
- [commander](https://npm.io/package/commander.md) ^2.18.0

## Recent versions

- 1.0.5 (latest) — 2019-08-08
- 1.0.3 — 2019-07-02
- 1.0.2 — 2019-07-02
- 1.0.1 — 2019-07-02

## README

# Express API Server Boiler Plate
## How to create your new Express API server app:

run this command to install the cli globally in your machine:

``` 
npm install express-server-cli -g
```

Now go to the dir you want your app to be in then run this command:

``` 
express-server-cli create <dirname>
```

Do not put braces and name should be all lowercase without any space(use - or _ instead)

Now you will have an app in the dir you mentioned in the cmd above

## Starting Express server

just run: 

``` 
npm install
```

``` 
npm start
```

I use nodemon for faster development: 

``` 
npm install nodemon -g
```

if you are using nodemon:

``` 
npm run dev
```


## CLI Features

### Create a Module

This feature will create a module and will save your time of creating new files with this cmd:

``` 
express-server-cli create-module <modulename>
```

## App Features

When you will generate a new app. you will have bunch of configured and ready to be used libraries in your lib folder which are: 

### Bcrypt

Bcrypt module is commonly used for generating password hash. However the module is congifured to be used anywhere a/c to requirements.


### Email

Email is a ready to use module for sending verification/confirmation emails to users.    

Using: 
[Node Mailer](https://nodemailer.com/about/)
and 
[Sendgrid](https://sendgrid.com/)

### JWT 

JSON Web Token configured and ready to use for generating API access tokens or anything else.  

Using: 
[JWT](https://jwt.io/)

### Logger

Application logger configured to log info in app.log file.   

**NOTE:** Make sure to create a app.log file in the production environment only.

Using: 
[Bunyan](https://www.npmjs.com/package/bunyan)


### Multer

Multer is a file uploader module. Its provides form data configuration for express app.  

Using: [Multer](https://www.npmjs.com/package/multer)

### SMS

Configured and ready to use SMS module for sending verification/confirmation or any other SMS to users.  

Using: [Twilio](https://www.twilio.com/)

### Scripts

Creating super admin and making db backup everyday are done through scripts. Which are already written and ready to use for you:

For Super Admin:

``` 
npm run create-admin
```

For Everyday DB Backup:

``` 
npm run db_backup_cron
```

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