Skip to content

Commit

Permalink
fix(build, readme): relax engine requirement, gitignore docs
Browse files Browse the repository at this point in the history
* build, relax engine requirement
* readme, gitignore basics for default generated .docs directory
  • Loading branch information
cdcabrera committed Apr 14, 2019
1 parent 39ecc3a commit 38231d1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ or Yarn
```

Then follow the guide for [apidoc](http://apidocjs.com/). From there run the NPM script, and open [localhost:5000/[PATH TO API ENDPOINT]](http://localhost:5000/).

It's recommended you make sure to `.gitignore` the `.docs` directory that gets generated for `apidocs`.

### Or roll with a Docker setup

Expand Down Expand Up @@ -116,14 +118,16 @@ From there you should be able to navigate to

1. Next
#### Using a NPM script setup
Setup your NPM scripts
Then, make sure to `.gitignore` the `.docs` directory that gets generated for `apidocs`.

Then, setup your NPM scripts
```js
"scripts": {
"mock": "mock -p 5000 -w [PATH TO YOUR JS FILES] -w [ANOTHER PATH TO YOUR JS FILES]"
}
```

Then, run your script
And then run your script

```shell
$ npm run mock
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"url": "https://github.com/cdcabrera/apidoc-mock/issues"
},
"engines": {
"node": ">=10.14.2"
"node": ">=10.0.0"
},
"bin": {
"mock": "./bin/cli.js"
Expand Down

0 comments on commit 38231d1

Please sign in to comment.