First commit.

Author: hanchiang

.dockerignore

@@ -0,0 +1,11 @@
+Dockerfile*
+docker-compose*
+.dockerignore
+npm-debug.log
+.git
+.gitignore
+node_modules
+dist
+build
+README.md
+.vscode

.eslintignore

@@ -0,0 +1 @@
+node_modules/**

.eslintrc

@@ -0,0 +1,20 @@
+{
+  "extends": [
+    "koa",
+    "prettier",
+    "prettier/@typescript-eslint"
+  ],
+  "plugins": [
+    "prettier",
+    "@typescript-eslint"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "rules": {
+    "arrow-parens": 0,
+    "no-unused-vars": 0,
+  }
+}

.gitignore

@@ -0,0 +1,9 @@
+node_modules
+test.js
+coverage
+npm-debug.log
+.DS_Store
+.nyc_output
+.env.dev
+.env.test
+dist

Dockerfile

@@ -0,0 +1,40 @@
+# 1. --- Base ---
+FROM node:12.13-stretch-slim AS base
+
+# install dependencies first, in a different location for easier app bind mounting for local development
+# due to default /opt permissions we have to create the dir with root and change perms
+RUN mkdir -p /opt/node_app && chown -R node:node /opt/node_app
+WORKDIR /opt/node_app
+
+# the official node image provides an unprivileged user as a security best practice
+# but we have to manually enable it. We put it here so npm installs dependencies as the same
+# user who runs the app. 
+# https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md#non-root-user
+USER node
+COPY package*.json ./
+
+
+# 2. --- Dependencies ---
+FROM base AS dependencies
+ENV NODE_ENV development
+ENV PORT 3000
+
+RUN npm install
+ENV PATH /opt/node_app/node_modules/.bin:$PATH
+
+# copy in our source code last, as it changes the most
+COPY --chown=node:node . .
+RUN npm run build
+CMD [ "npm", "run", "dev" ]
+
+
+# 3. --- Release ---
+FROM base AS release
+ENV NODE_ENV production
+ENV PORT 3000
+ENV PATH /opt/node_app/node_modules/.bin:$PATH
+
+COPY --from=dependencies ./opt/node_app/dist ./dist
+RUN npm ci --only=production
+CMD [ "npm", "run", "start" ]
+

Dockerfile-dev

@@ -0,0 +1,28 @@
+FROM node:12.13-stretch-slim
+
+ARG NODE_ENV=development
+ENV NODE_ENV $NODE_ENV
+
+ARG PORT=3000
+ENV PORT $PORT
+EXPOSE $PORT
+
+RUN mkdir -p /opt/node_app && chown -R node:node /opt/node_app
+WORKDIR /opt/node_app
+
+# the official node image provides an unprivileged user as a security best practice
+# but we have to manually enable it. We put it here so npm installs dependencies as the same
+# user who runs the app. 
+# https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md#non-root-user
+
+USER node
+COPY package*.json ./
+RUN npm ci
+ENV PATH /opt/node_app/node_modules/.bin:$PATH
+
+# copy in our source code last, as it changes the most
+COPY --chown=node:node . .
+
+RUN tsc
+
+CMD [ "npm", "run", "dev" ]

README.md

@@ -0,0 +1,31 @@
+# Introduction
+This is a typescript koa project, with docker, docker compose, error handlers, test, prettier, eslint set up
+
+# Setup
+## Install required tools
+* [docker setup](https://docs.docker.com/install/)
+* [docker-compose setup](https://docs.docker.com/compose/install/)
+
+## Clone project
+* `git clone git@github.com:hanchiang/typescript-node-docker.git`
+
+## Set up environment variables
+`.env.dev`:
+* `COOKIE_SECRET=mycookiesecret`
+* `NODE_ENV=development`
+
+# Running the project
+**Run in development mode**
+* Build: `docker-compose build`
+* Start: `docker-compose up -d`
+* Server is available at: `localhost:6001`
+* Stop: `docker-compose down`
+
+# Note
+Whenever new packages are added via `npm install`:
+* You need to stop the service: `docker-compose stop <service>` or `docker-compose down`
+* Build the service: `docker-compose build <service>`
+* Start the service: `docker-compose start <service>` or `docker-compose up -d`
+
+# Reference
+* Multi stage docker build - https://medium.com/@ankit.wal/the-why-and-how-of-multi-stage-docker-build-with-typescript-example-bcadbce2686c

docker-compose.override.yml

@@ -0,0 +1,9 @@
+version: "3.4"
+
+services:
+  node-app:
+    environment:
+      - NODE_ENV=development
+      - COOKIE_SECRET=cookiesecret
+    ports:
+      - 3000:3000

docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.4"
+
+services:
+  node-app:
+    container_name: node-app
+    build:
+      context: .
+      target: dependencies
+      dockerfile: Dockerfile
+    image: node-app:dev
+    command: npm run dev
+    volumes:
+      - ./:/opt/node_app
+      - ./package.json:/opt/node_app/package.json
+      - ./package-lock.json:/opt/node_app/package-lock.json
+      - /opt/node_app/node_modules