You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+15-4
Original file line number
Diff line number
Diff line change
@@ -54,6 +54,7 @@ This is a GitHub Template so either click the ['use this template'](https://gith
54
54
- standardised [`node-http-error`](https://github.com/carsondarling/node-http-error) and [`http-status-codes`](https://github.com/prettymuchbryce/http-status-codes) and simple `generic` and `notFound` error handlers
55
55
-[`dotenv`](https://github.com/motdotla/dotenv) support
56
56
- the swagger editor as an easy to invoke docker image
@@ -68,7 +69,6 @@ This is a GitHub Template so either click the ['use this template'](https://gith
68
69
- 100% unit test coverage using [`nyc`](https://github.com/istanbuljs/nyc)
69
70
- integration testing using [`supertest`](https://github.com/visionmedia/supertest)
70
71
- code quality using [`eslint`](https://eslint.org) and [`prettier`](https://prettier.io)
71
-
- mutation testing with [`stryker-mutator`](https://stryker-mutator.io)
72
72
-[`circleci`](https://circleci.com) integration
73
73
-[`snyk`](https://snyk.io) integration
74
74
@@ -95,8 +95,9 @@ I've paired this right back to the simplest, most generic API I could, so there'
95
95
96
96
### Prerequisites
97
97
98
-
-[NodeJS](htps://nodejs.org), version 12.18.4 (LTS) or better. (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
99
-
-[Docker](https://www.docker.com) if you want to use the Swagger Editor. (Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the `homebrew` version)
98
+
-[NodeJS](htps://nodejs.org), I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.
99
+
-[Docker](https://www.docker.com) if you want to use the Swagger Editor, or you wish to use a `buildpack`. Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the `homebrew` version.
100
+
-[Pack](https://buildpacks.io) to use `buildpacks` — `brew install buildpacks/tap/pack`
100
101
101
102
### To build and run locally
102
103
@@ -113,6 +114,17 @@ You can then go to [localhost:8282/docs](http://127.0.0.1:8282/docs) to see the
113
114
114
115
You can put environment variables in a `.env` file.
0 commit comments