Setup docker for local development and debugging

Write README

Author: roschaefer

Dockerfile

@@ -6,31 +6,21 @@ RUN apk update && apk upgrade
 RUN rm -rf /var/cache/apk/*
 RUN yarn global add pm2
 
-# expose the app port
-EXPOSE 3030
-
-# set environment variables
-# ENV NPM_CONFIG_PRODUCTION=false
-# ENV HOST=0.0.0.0
-ENV NODE_ENV=production
-ENV API_PORT=3030
-
-# start the application in a autohealing cluster
-# NOTE: quick fix for server issues, restart api when reaching max of 300 MB Memory Usage (happens in conjunction with 100% CPU Usage)
-# TODO: find better way of dealing with that issue
-CMD NODE_ENV=production pm2 start server/index.js -n api --attach --max-memory-restart 1024M
-# CMD NODE_ENV=production pm2 start server/index.js -n api -i 2 --attach
-# as we have issues with pm2 currently in conjunction with nuxt, we use the standard approach here
-# CMD NODE_ENV=production node server/index.js
-
 # create working directory
-RUN mkdir -p /var/www/
-WORKDIR /var/www/
+RUN mkdir -p /API
+WORKDIR /API
 
 # install app dependencies
-COPY package.json /var/www/
-COPY yarn.lock /var/www/
+COPY package.json /API
+COPY yarn.lock /API
 RUN yarn install --frozen-lockfile --non-interactive
 
 # copy the code to the docker image
-COPY . /var/www/
+COPY . /API
+
+# setup local configuration
+COPY ./config/docker/* /API/config/
+
+# expose the app port
+EXPOSE 3030
+EXPOSE 9229

README.md

@@ -17,6 +17,42 @@ The API for a better world. More information under [human-connection.org](https:
 
 > **Note:** This is only the API part of Human-Connection, you have to also checkout the [WebApp](https://github.com/Human-Connection/WebApp) which uses this API.
 
+## Installation via docker
+
+Make sure you have a recent version of [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/).
+
+Run:
+```bash
+$ docker-compose up --build
+```
+Now, your API should be running at [http://localhost:3030](http://localhost:3030)
+and you can see some contributions at [http://localhost:3030/contributions](http://localhost:3030/contributions).
+
+For debugging you can run:
+```bash
+$ docker-compose run --rm --service-ports api yarn run dev:debug
+```
+And debug your app with [Chrome Dev Tools](chrome://inspect).
+
+### Configuration in Docker
+
+Change configuration in `config/docker/local-development.json` or
+`config/docker/local.json` and rerun `docker-compose up --build`.
+
+### Testing in Docker
+
+Run the entire test suite with:
+```bash
+$ docker-compose run --rm api yarn run test
+```
+
+If you want you can run specific tests:
+```bash
+$ docker-compose run --rm api yarn run mocha
+$ docker-compose run --rm api yarn run cucumber
+```
+
+
 ## Local installation
 
 > we recommand to install the project locally for the best development ease and performance
@@ -103,7 +139,7 @@ Getting up and running is as easy as 1, 2, 3, 4 ... 5.
 
    > Do not forget to always start it if you choose that setup or otherwise you will not see any pictures at all.
 
-### Local configuration
+### Local Configuration
 
 You can override any default configuration in `config/local.json`. You can find
 a list of availabe defaults in `config/default.json`.
@@ -121,7 +157,7 @@ replace `localhost` in your settings with your IP address in the local network:
 
 ```
 
-## Testing
+### Local Testing
 
 Run the entire test suite with:
 ```bash

config/docker/local-development.json

@@ -0,0 +1,7 @@
+{
+  "mongodb": "mongodb://mongo:27017/hc_api",
+  "seeder": {
+    "runOnInit": true,
+    "dropDatabase": false
+  }
+}

config/docker/local-test.json

@@ -0,0 +1,3 @@
+{
+  "mongodb": "mongodb://mongo:27017/hc_api_test"
+}

config/docker/local.json

@@ -0,0 +1,8 @@
+{
+  "host": "0.0.0.0",
+  "smtpConfig": {
+    "host": "maildev",
+    "port": 25,
+    "ignoreTLS": true
+  }
+}

docker-compose.yml

@@ -1,16 +1,21 @@
-version: '2'
+version: '3'
 
 services:
-  mongo-cluster:
-    image: mongo
-    ports:
-      - "27017:27017"
-    command: "--smallfiles --logpath=/dev/null"
   api:
     build: .
     ports:
       - "3030:3030"
+      - "9229:9229" # node inspect
     links:
-      - mongo-cluster
+      - mongo
     environment:
-      PORT: 3030
+      - NODE_ENV=development
+    command: yarn run dev
+  mongo:
+    image: mongo
+    command: "--smallfiles --logpath=/dev/null"
+  maildev:
+    image: djfarrelly/maildev
+    ports:
+      - "1080:80"
+      - "1025:25"