Initial working version

Author: Stefan Walther

README.md

@@ -4,17 +4,28 @@
 ## Installation
 
 ```sh
+# Clone the directory
+$ git clone https://github.com/stefanwalther/boilerplate-typescript-rest-docker
+
+# Switch to the cloned directory
+$ cd boilerplate-typescript-rest-docker
+
+# Install dependencies (not needed if you only run the container)
 $ npm install
 ```
 
-## Development
+## Development Workflow
 
 Run the development environment
+```sh
+# omit --build if you don't want to re-build the container again and again
+$ docker-compose --f=./docker/dev.yml up --build
 ```
-docker-compose --f ./docker/dev.yml up --build
-```
-
 
-The REST service is available at:
+The development environment contains the following:
+- A docker container called `rest-service` containing the REST server as defined in `./src`.
+- The REST services is exposed at `http://localhost:8000`.
+- Watcher: As soon as you make changes to the `./src` folder, the TypeScript files will be transpiled again and the server restarted.
+- Remote debugging enabled through port `5858`.
 
-http://localhost:8000
+### Debugging in Webstorm

docker/ci.yml

@@ -10,4 +10,7 @@ services:
     command: "npm run start:dev"
     ports:
       - "8000:8000"
+      # Debugger
       - "5858:5858"
+      # Inspector
+      - "9222:9222"

docker/dev.yml

@@ -0,0 +1 @@
+PORT=8000

docker/rest-service/.env

@@ -9,7 +9,7 @@ COPY package.json .
 COPY tsconfig.json .
 
 RUN npm install nodemon -g \
-  && npm install node-inspector -g \
+#  && npm install node-inspector -g \
   && npm install
 
 COPY ./src/ ./src/

docker/rest-service/Dockerfile

@@ -1,11 +1,12 @@
 {
-  "name": "boilerplate-typescript-rest",
+  "name": "boilerplate-typescript-rest-docker",
   "version": "0.0.1",
-  "description": "Boilerplate for a REST service using TypeScript.",
+  "description": "Boilerplate for a REST service using TypeScript & Docker.",
   "main": "index.js",
   "scripts": {
     "start": "npm run transpile && node ./src/index.js",
-    "start:debug": "npm run transpile && node --debug ./src/index.js",
+    "start:inspect": " --inspect=9222",
+    "start:debug": "npm run transpile && node --debug=5858 ./src/index.js",
     "start:dev": "nodemon --watch src -L --exec npm run start:debug",
     "transpile": "node ./node_modules/typescript/bin/tsc  --listEmittedFiles",
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -33,6 +34,7 @@
     "eslint-config-idiomatic": "^2.1.0",
     "mocha": "^3.1.2",
     "supertest": "^2.0.1",
+    "supertest-as-promised": "^4.0.2",
     "ts-node": "^1.7.0",
     "typescript": "^2.0.9",
     "typescript-eslint-parser": "^1.0.0"
@@ -43,7 +45,11 @@
     "@types/express": "^4.0.33",
     "@types/mocha": "^2.2.32",
     "@types/node": "^6.0.46",
+    "@types/supertest": "^1.1.31",
+    "@types/supertest-as-promised": "^2.0.32",
     "body-parser": "^1.15.2",
-    "express": "^4.14.0"
+    "express": "^4.14.0",
+    "install": "^0.8.2",
+    "npm": "^3.10.9"
   }
 }

package.json

@@ -1,4 +1,4 @@
 import { Server } from './server';
 
 let serverInst = new Server();
-serverInst.start();
+serverInst.start();