feat: total refactor, allow overriding options, bump deps, bump node

Author: codfish

.dockerignore

@@ -0,0 +1 @@
+node_modules

.lintstagedrc.js

@@ -1,4 +1,5 @@
 module.exports = {
-  '*.{json,md}': ['prettier --write', 'git add'],
+  '*.{json}': ['prettier --write', 'git add'],
+  '*.md': ['prettier --write', 'markdownlint', 'git add'],
   '*.js': ['eslint --fix', 'git add'],
 };

.travis.yml

@@ -2,7 +2,7 @@ sudo: false
 
 language: node_js
 
-node_js: '10'
+node_js: '12'
 
 cache:
   directories:

Dockerfile

@@ -1,12 +1,13 @@
-FROM node:11.12
+FROM node:12.4
 
 RUN mkdir /app
 WORKDIR /app
 
+RUN npm install -g json-server
 COPY package.json package-lock.json ./
 RUN npm ci --only="prod"
 
-COPY index.js middleware.js routes.json ./
+COPY ./db.js ./middleware.js ./routes.json ./server.sh ./
 
 EXPOSE 80
-CMD npm run start
+CMD [ "./server.sh" ]

README.md

@@ -3,7 +3,7 @@
 Docker image for building a [json-server](https://github.com/typicode/json-server) application.
 
 This image will set up the application for you and allow you to simply mount in your "database
-source file". Currently it's required that file be `index.js`. You can also optionally mount in a
+source file", which by convention needs to be named `db.js`. You can also optionally mount in a
 `middleware.js` and `routes.json` file.
 
 Example `docker-compose.yml` file:
@@ -12,32 +12,103 @@ Example `docker-compose.yml` file:
 version: '3'
 
 services:
-  docs:
-    image: codfish/json-server:0.14.2
-    command: npm run dev
+  json-server:
+    image: codfish/json-server:0.15.0
     volumes:
-      - ./index.js:/app/index.js:delegated
+      - ./db.js:/app/db.js:delegated
       - ./routes.json:/app/routes.json:delegated
       - ./middleware.js:/app/middleware.js:delegated
 ```
 
 Image versions are based off of the
 [release versions for json-server](https://github.com/typicode/json-server/releases). However there
 is not an image for every version. See the available versions
-here](https://hub.docker.com/r/codfish/json-server).
+[here](https://hub.docker.com/r/codfish/json-server).
+
+## Usage
+
+The container runs the `json-server` cli 2 ways. By default it will run it directly but you can
+easily override the command by running it through nodemon. The image is setup to do this already
+through npm. Just change the command to `npm run dev`.
+
+```yml
+version: '3'
+
+services:
+  json-server:
+    image: codfish/json-server:0.15.0
+    command: npm run dev
+```
+
+To test this image directly you can run:
+
+```sh
+git clone [email protected]:codfish/json-server-docker.git
+docker-compose up -d
+```
+
+It's recommended to first install & start [`docker-proxy`](https://github.com/aj-may/docker-proxy).
+The server will then be available at <http://json-server.docker>.
+
+### Options
+
+`json-server` cli options: <https://github.com/typicode/json-server#cli-usage>
 
-## Helper Libraries
+For the most part this image will rely on the default options that `json-server` has set. For
+certain options like `--port` and `--host`, it overrides the defaults with it's own defaults that
+work well with containers out of the box. We've also set a default routes & middleware filename so
+all you need to do is mount over the files. No configuration is necessary for that.
+
+However you still have the ability to override _almost_ every option yourself as well. Options
+should be passed in as environment variables. The currently supported options available for:
+
+| Option        | Description                                                      | Default                                                     |
+| ------------- | ---------------------------------------------------------------- | ----------------------------------------------------------- |
+| `PORT`        | Set port                                                         | `80`                                                        |
+| `HOST`        | Set host                                                         | `0.0.0.0`                                                   |
+| `ROUTES`      | Path to routes file                                              | `routes.json` (Stored in image, optionally mount over it)   |
+| `MIDDLEWARES` | Path to middleware file                                          | `middleware.js` (Stored in image, optionally mount over it) |
+| `CONFIG`      | Path to config file                                              | Defers to `json-server` default                             |
+| `ID`          | Set database id property (e.g. `address`)                        | Defers to `json-server` default                             |
+| `FKS`         | Set foreign key suffix, (e.g. `Address` as in `contractAddress`) | Defers to `json-server` default                             |
+| `DELAY`       | Add delay to responses (ms)                                      | -                                                           |
+| `STATIC`      | Set static files directory                                       | Defers to `json-server` default                             |
+| `QUIET`       | Suppress log messages from output                                | Boolean flag only true if set                               |
+| `NO_GZIP`     | Disable GZIP Content-Encoding                                    | Boolean flag only true if set                               |
+| `NO_CORS`     | Disable Cross-Origin Resource Sharing                            | Boolean flag only true if set                               |
+| `READ_ONLY`   | Allow only GET requests                                          | Boolean flag only true if set                               |
+
+For details on the options
+[view `json-server`'s documentation](https://github.com/typicode/json-server#cli-usage).
+
+### Full Example
+
+Here's a recommended setup for local development with some optional overrides as an example.
+
+```yaml
+services:
+  json-server:
+    image: codfish/json-server:0.15.0
+    command: npm run dev
+    volumes:
+      - ./db.js:/app/db.js:delegated
+      - ./routes.json:/app/routes.json:delegated
+      - ./middleware.js:/app/middleware.js:delegated
+    environment:
+      VIRTUAL_HOST: json-server.docker
+      FKS: Address
+      ID: address
+      NO_CORS: 'true'
+      NO_GZIP: 'true'
+```
+
+## Database File
 
 When building your mock api's you'll most like want to generate some fake data and return a number
 of items for a specific collection. I've included [Lodash](https://lodash.com/) &
 [faker.js](https://github.com/Marak/faker.js) in the image to help facilitate doing these sorts of
 things inside your source file, or middleware for that matter. Here's an example of what I mean:
 
-#### index.js
-
-The source file you provide to json-server needs to be a json file, or js file that export's an
-object. You will have access to `faker.js` and `Lodash` to help you out.
-
 ```js
 const faker = require('faker');
 const times = require('lodash/times');
@@ -55,5 +126,4 @@ module.exports = () => ({
 
 ## Todo
 
-- Support multiple database file types (`db.json` vs `index.js` for instance)
 - Add examples of using this with docker cli, without a compose file

index.js db.js

@@ -1,13 +1,12 @@
 version: '3'
 
 services:
-  api:
+  json-server:
     build: .
     command: npm run dev
     volumes:
-      - ./index.js:/app/index.js
-      - ./package.json:/app/package.json:delegated
+      - ./db.js:/app/db.js
       - ./routes.json:/app/routes.json:delegated
       - ./middleware.js:/app/middleware.js:delegated
     environment:
-      VIRTUAL_HOST: json-server-docker.docker
+      VIRTUAL_HOST: json-server.docker