Merge pull request #100 from codfish/upgrades

Bump to node v18.15 and json-server v0.17.3, migrate to new faker

Author: codfish

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Publish Docker Image
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+jobs:
+  publish-to-dockerhub:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: codfish/json-server
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/validate.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
-          node-version: 12.x
+          node-version-file: .nvmrc
 
       - name: install dependencies
         run: npm ci

.nvmrc

@@ -0,0 +1 @@
+v18.15.0

Dockerfile

@@ -1,9 +1,9 @@
-FROM node:14.15-slim
+FROM node:18.15.0-slim
 
 RUN mkdir /app
 WORKDIR /app
 
-ENV JSON_SERVER_VERSION=0.16.3
+ENV JSON_SERVER_VERSION=0.17.3
 
 RUN npm install -g json-server@${JSON_SERVER_VERSION}
 COPY package.json package-lock.json ./

README.md

@@ -51,8 +51,10 @@ cd json-server-docker
 docker-compose up -d
 ```
 
-I highly recommend installing [`dotdocker`](https://github.com/aj-may/dotdocker) first. The
-container will then be accessible at <http://json-server.docker>.
+Visit <http://localhost:9999/> to see your running JSON Server.
+
+If you have [`dotdocker`](https://github.com/aj-may/dotdocker) installed the server will also be
+accessible at <http://json-server.docker>.
 
 ### Options
 
@@ -109,22 +111,22 @@ services:
 ## 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:
+of items for a specific collection. [Faker](https://github.com/faker-js/faker) is included in the
+image to help facilitate doing these sorts of things inside your db or middleware files. For
+example:
 
 ```js
-const faker = require('faker');
-const times = require('lodash/times');
-const startCase = require('lodash/startCase');
+const faker = require('@faker-js/faker');
 
 module.exports = () => ({
-  posts: times(100, index => ({
-    id: index,
-    title: startCase(faker.lorem.words(3)),
-    body: faker.lorem.paragraphs(3),
-    // and so on...
-  })),
+  posts: faker.helpers.multiple(
+    () => ({
+      id: faker.datatype.uuid(),
+      title: faker.lorem.words(3),
+      body: faker.lorem.paragraphs(3),
+    }),
+    { count: 100 },
+  ),
 });
 ```
 
@@ -159,9 +161,3 @@ feature change with our implementation but the `json-server` version doesn't cha
 ```sh
 git tag -fa v0.16.1 -m "Update v0.16.1 tag" && git push origin v0.16.1 --force
 ```
-
-Docker Hub is configured to automatically build on new tags pushed to GitHub.
-
-## Todo
-
-- Add examples of using this with docker cli, without a compose file

db.js

@@ -1,8 +1,17 @@
+const { faker } = require('@faker-js/faker');
+
 /**
  * This is a the main database file. It's meant to be mounted over.
  */
 module.exports = () => ({
-  posts: [{ id: 10, title: 'json-server', author: 'typicode' }],
+  posts: faker.helpers.multiple(
+    () => ({
+      id: faker.datatype.uuid(),
+      title: faker.lorem.words(3),
+      body: faker.lorem.paragraphs(3),
+    }),
+    { count: 100 },
+  ),
   comments: [{ id: 1, body: 'some comment', postId: 1 }],
   profile: { name: 'typicode' },
 });

docker-compose.yml

@@ -8,5 +8,7 @@ services:
       - ./db.js:/app/db.js
       - ./routes.json:/app/routes.json:delegated
       - ./middleware.js:/app/middleware.js:delegated
+    ports:
+      - 9999:80
     environment:
       VIRTUAL_HOST: json-server.docker