Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(build, readme): relax engine requirement, gitignore #16

Merged
merged 1 commit into from
Apr 14, 2019
Merged

fix(build, readme): relax engine requirement, gitignore #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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