Skip to content

Commit 8149ae5

Browse files
authored
Merge pull request kunalkapadia#120 from KunalKapadia/fix-readme
Replace gulp with npm tasks in README
2 parents abbee9c + 6c8d0e3 commit 8149ae5

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,16 @@ npm install
5151

5252
Start server:
5353
```sh
54-
# set DEBUG env variable to get debug logs
54+
# Start server
55+
npm start
56+
57+
# Selectively set DEBUG env var to get logs
5558
DEBUG=express-mongoose-es6-rest-api:* npm start
56-
# OR
57-
# requires gulp to be installed globally
58-
npm i -g gulp
59-
gulp serve
6059
```
60+
Refer [debug](https://www.npmjs.com/package/debug) to know how to selectively turn on logs.
61+
6162

62-
Execute tests:
63+
Tests:
6364
```sh
6465
# Run tests written in ES6 along with code coverage
6566
npm test
@@ -71,14 +72,19 @@ npm run test:watch
7172
npm run test:check-coverage
7273
```
7374

74-
Other gulp tasks:
75+
Lint:
7576
```sh
76-
# Wipe out dist and coverage directory
77-
gulp clean
78-
7977
# Lint code with ESLint
8078
npm run lint
79+
80+
# Run lint on any file change
8181
npm run lint:watch
82+
```
83+
84+
Other gulp tasks:
85+
```sh
86+
# Wipe out dist and coverage directory
87+
gulp clean
8288

8389
# Default task: Wipes out dist and coverage directory. Compiles using babel.
8490
gulp
@@ -88,7 +94,7 @@ gulp
8894

8995
```sh
9096
# compile to ES5
91-
1. npm run build or gulp
97+
1. npm run build
9298

9399
# upload dist/ to your server
94100
2. scp -rp dist/ user@dest:/path

0 commit comments

Comments
 (0)