Skip to content

Commit 2e1e4fc

Browse files
committed
Updated Readme
1 parent cb20020 commit 2e1e4fc

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Nodejs boilerplate with express,Mongoose,ES8,Jwt to develop rest api
2323
- uses [yarn](https://yarnpkg.com) over [npm](https://www.npmjs.com/)
2424
- Application level errorHandler
2525
- Manage enviroment via [dotenv](https://github.com/rolodato/dotenv-safe)
26+
- Code coverage with [istanbul](https://github.com/istanbuljs/nyc)
2627

2728
## Getting Started
2829
1. Clone repository
@@ -46,6 +47,15 @@ Nodejs boilerplate with express,Mongoose,ES8,Jwt to develop rest api
4647
```
4748
> yarn dev OR npm run dev
4849
```
50+
6. Run tests
51+
```
52+
> yarn test
53+
```
54+
7. Generate coverage report
55+
```
56+
> yarn test:coverage
57+
```
58+
Note : Open coverage/lcov-report/index.html
4959

5060
## Running with docker
5161
```

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "1.0.0",
44
"description": "A rest api boilerplate using nodejs,mongoose,jwt,es8,joi,nodemon,yarn with testing and code coverage",
55
"main": "index.js",
6+
"private": false,
67
"dependencies": {
78
"bcrypt": "^3.0.4",
89
"body-parser": "^1.18.3",
@@ -74,6 +75,6 @@
7475
"integration tests",
7576
"joi validation"
7677
],
77-
"author": "Vibhas Bhingarde",
78+
"author": "Vibhas Bhingarde <[email protected]>",
7879
"license": "MIT"
7980
}

0 commit comments

Comments
 (0)