@lykmapipo/express-common
Version:
minimal express app configuration
118 lines (88 loc) • 4.76 kB
Markdown
# express-common
[](https://travis-ci.com/lykmapipo/express-common)
[](https://david-dm.org/lykmapipo/express-common)
[](https://coveralls.io/github/lykmapipo/express-common?branch=master)
[](https://github.com/lykmapipo/express-common/blob/master/LICENSE)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/prettier/prettier)
[](https://github.com/airbnb/javascript)
[](https://www.npmjs.com/package/@lykmapipo/express-common)
minimal express app configuration.
It use below packages:
- [body-parser](https://github.com/expressjs/body-parser)
- [compression](https://github.com/expressjs/compression)
- [cors](https://github.com/expressjs/cors)
- [dotenv](https://github.com/motdotla/dotenv)
- [helmet](https://github.com/helmetjs/helmet)
- [method-override](https://github.com/expressjs/method-override)
- [morgan](https://github.com/expressjs/morgan)
- [@lykmapipo/express-request-extra](https://github.com/lykmapipo/express-request-extra)
- [@lykmapipo/express-router-extra](https://github.com/lykmapipo/express-router-extra)
- [express-mquery](https://github.com/lykmapipo/express-mquery)
*Note: It highly advice to use TLS*
## Requirements
- NodeJS v9.3.0+
- express v4.16.4+
## Install
```sh
$ npm install --save @lykmapipo/express-common
```
## Usage
```js
import { get, post, patch, del, start } from '@lykmapipo/express-common';
get('/v1/users', (req, res) => res.ok({ ... }));
get('/v1/users/:id', (req, res) => res.ok({ ... }));
post('/v1/users', (req, res) => res.created({ ... }));
patch('/v1/users:/id', (req, res) => res.ok({ ... }));
del('/v1/users:/id', (req, res) => res.ok({ ... }));
start(error => { ... });
```
```curl
curl http://0.0.0.0:5000/v1/users
```
## Environment
```js
NODE_ENV=development
PORT=5000
TRUST_PROXY=false
SERVE_STATIC=true
SERVE_STATIC_PATH=public
SERVE_FAVICON=false
BODY_PARSER_LIMIT=2mb
BODY_PARSER_JSON_TYPE=application/json
HELMET_HSTS=false
MQUERY_LIMIT=10
MQUERY_MAX_LIMIT=50
LOGGER_LOG_ENABLED=true
LOGGER_LOG_LEVEL=silly
LOGGER_USE_CONSOLE=true
LOGGER_USE_FILE=true
LOGGER_LOG_PATH=./logs/app-%DATE%.log
LOGGER_LOG_IGNORE=password,apiKey,secret,client_secret
LOGGER_LOG_HTTP_FORMAT=combined
```
## Testing
* Clone this repository
* Install all development dependencies
```sh
$ npm install
```
* Then run test
```sh
$ npm test
```
## Contribute
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
## References
- [expressjs](https://expressjs.com/)
- [Production Best Practices](https://expressjs.com/en/advanced/best-practice-security.html)
- [Production Best Practices](https://expressjs.com/en/advanced/best-practice-performance.html)
- [Using Middleware](http://expressjs.com/en/guide/using-middleware.html)
- [Health Checks and Graceful Shutdown](https://expressjs.com/en/advanced/healthcheck-graceful-shutdown.html)
- [The Twelve Factors App](https://12factor.net/)
## Licence
The MIT License (MIT)
Copyright (c) lykmapipo & Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.