Merge pull request #101 from codfish/updates

Node v20, Typescript, Improved documentation

Author: codfish

.github/PULL_REQUEST_TEMPLATE.md

@@ -19,5 +19,22 @@ jobs:
       - name: lint js
         run: npm run lint
 
-      - name: ensure the image builds properly
-        run: docker-compose build
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: codfish/json-server
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/validate.yml

@@ -93,3 +93,4 @@ typings/
 # Custom
 dist
 build
+api

.gitignore

@@ -1 +1 @@
-v18.15.0
+v20.2.0

.nvmrc

@@ -1,15 +1,20 @@
-FROM node:18.15.0-slim
+FROM node:20.2.0-slim
 
 RUN mkdir /app
 WORKDIR /app
 
-ENV JSON_SERVER_VERSION=0.17.3
-
-RUN npm install -g json-server@${JSON_SERVER_VERSION}
 COPY package.json package-lock.json ./
-RUN npm ci --only="prod"
+RUN npm ci --omit=dev
+RUN npm install -g --save-exact [email protected] [email protected]
 
-COPY ./db.js ./middleware.js ./routes.json ./server.sh ./
+# copy in files
+COPY ./tsconfig.json \
+     ./db.js \
+     ./middleware.js \
+     ./routes.json \
+     ./server.sh \
+     ./main.sh ./
 
 EXPOSE 80
-CMD [ "./server.sh" ]
+
+CMD [ "./main.sh" ]

Dockerfile

@@ -1,8 +1,21 @@
-The MIT License (MIT)
-Copyright (c) 2019 Chris O'Donnell
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2023 Chris O'Donnell
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.