Merge pull request #13 from Talento90/refactor-template

Refactor template

Author: Talento90

.editorconfig

@@ -10,3 +10,9 @@ insert_final_newline = true
 
 [*.md]
 trim_trailing_whitespace = false
+indent_style = space
+indent_size = 2
+
+[*.json]
+indent_style = space
+indent_size = 2

.gitignore

@@ -14,6 +14,7 @@ lib-cov
 # Coverage directory used by tools like istanbul
 coverage
 reports
+.nyc_output
 
 
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
@@ -29,12 +30,6 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-#VSCode
-.vscode
-
-#Ignore build folder
-build
-
-#Ignore typings
-typings
+#Ignore dist folder
+dist
 

.nvmrc

@@ -0,0 +1 @@
+8.10

.travis.yml

@@ -1,8 +1,25 @@
 language: node_js
 node_js:
-  - "7"
-before_script:
-  - npm install -g typescript
-  - npm install -g gulp
+  - "8"
+env:
+  global:
+    - PORT=8080
+    - DB_HOST=127.0.0.1
+    - DB_PORT=3306
+    - DB_USER=travis
+    - DB_PASSWORD=secret
+
 services:
-  - mongodb
+  - mysql
+
+before_install:
+  - mysql -u root -e "SET PASSWORD FOR 'travis'@'localhost' = PASSWORD('secret')"
+  - mysql -u travis --password="secret" < db-scripts/create_database.sql
+
+install:
+  - npm install
+  - npm install -g codecov
+
+script:
+  - ./node_modules/nyc/bin/nyc.js --exclude dist/test --reporter lcovonly npm run test:all
+  - codecov

.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "type": "node",
+        "request": "launch",
+        "name": "Mocha Tests",
+        "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+        "args": [
+          "${workspaceRoot}/dist/test/**/*.js"
+        ],
+        "internalConsoleOptions": "openOnSessionStart",
+        "remoteRoot": "/app",
+        "outFiles": [
+          "${workspaceRoot}/dist/**/*.js"
+        ]
+      },
+      {
+        "type": "node",
+        "request": "attach",
+        "name": "Docker: Attach to Node",
+        "port": 5858,
+        "address": "localhost",
+        "localRoot": "${workspaceFolder}",
+        "remoteRoot": "/app",
+        "protocol": "inspector",
+        "outFiles": [
+          "${workspaceRoot}/dist/**/*.js"
+        ]
+      }
+    ]
+}

Dockerfile

@@ -1,27 +1,12 @@
-FROM mhart/alpine-node:6.9.1
+FROM node:8.10-alpine
 
-MAINTAINER Talento90
-
-# create a specific user to run this container
-RUN adduser -S -D user-app
-
-# add files to container
-ADD . /app
+USER nobody
 
 # specify the working directory
 WORKDIR app
 
-RUN chmod -R 777 .
-
-# build process
-RUN npm install
-RUN npm run build
-RUN npm prune --production
-
-# run the container using a specific user
-USER user-app
-
-EXPOSE 8080
+# expose server and debug port
+EXPOSE 8080 5858
 
 # run application
-CMD ["npm", "start"]
+CMD ["node", "dist/src/index.js"]

README.md

@@ -1,38 +1,38 @@
-# typescript-node [![Build Status](https://travis-ci.org/Talento90/typescript-node.svg?branch=master)](https://travis-ci.org/Talento90/typescript-node)
+# typescript-node [![Build Status](https://travis-ci.org/Talento90/typescript-node.svg?branch=master)](https://travis-ci.org/Talento90/typescript-node) [![codecov](https://codecov.io/gh/Talento90/typescript-node/branch/master/graph/badge.svg)](https://codecov.io/gh/Talento90/typescript-node)
 
-Boilerplate template for node and typescript services.
 
-## Deprecated
-Please for an updated version look at this repository: https://github.com/dwyl/hapi-typescript-example
+Template for building nodejs and typescript services. The main goal of this boilerplate is to offer a good Developer Experience (eg: debugging, watch and recompile) by providing the following features out of the box:
 
+***Features***
 
-**Installation**
+* Language - [TypeScript](https://www.typescriptlang.org/)
+* REST API - [koa2](http://koajs.com/)
+* Graceful Shutdown - [Pattern](https://nemethgergely.com/nodejs-healthcheck-graceful-shutdown/)
+* HealthCheck - [Patern /health](http://microservices.io/patterns/observability/health-check-api.html)
+* SQL Database & Migrations - [knex](http://knexjs.org/)
+* Authentication and Authorization - [JWT Tokens](https://github.com/auth0/node-jsonwebtoken)
+* Validation - [Joi](https://github.com/hapijs/joi)
+* Testing - [Mocha](https://mochajs.org/) [Chai](http://www.chaijs.com/) + [Sinon](http://sinonjs.org/) [Coverage](https://istanbul.js.org/)
+* Code Style - [Prettier](https://prettier.io/)
+* Git Hooks - [Husky](https://github.com/typicode/husky)
 
-* *npm run setup* (install nuget packages & typings)
+## Installation & Run
 
-**Run**
+* *npm install* - Install dependencies
+* *npm run start* - Start application (It needs a mysql database)
 
-* *gulp build* (build ts files)
-* *gulp test* (run mocha tests)
-* *gulp tslint* (run tslint)
-* *gulp watch* (watch ts files)
-* *npm run start* (start the application)
-* *npm run watch* (restart the application when files change)
-* *npm start* (run the application on http://localhost:5000/api/docs)
+### Running with Docker
 
-**Docker**
-* *docker-compose build* (compose images)
-* *docker-compose up* (running containers)
-* *browser: http://localhost:8080/docs* (have fun :)
+* *docker-compose up* (compose and run, it also creates the mysql database)
+* *docker-compose down* (Destroy application and mysql containers)
 
-**Features**
+## Useful npm commands
 
-* *Project Structure - Feature oriented*
-* *Hapijs - REST Api*
-* *Swagger - documentation*
-* *Jwt - authentication*
-* *Mongoose - MongoDb*
-* *nconf - configurations*
-* *Unit Tests - chai + sinon + mocha*
-
-Have fun :)
+* *npm run build* - Transpile TypeScript code
+* *npm run clean* - Remove dist, node_modules, coverage folders
+* *npm run coverage* - Run NYC coverage
+* *npm run lint* - Lint your TypeScript code
+* *npm run start:dev* - Run application in dev mode (debug & watch). Debug mode is running on port 5858 (open `chrome://inspect/#devices`).
+* *npm run test* - Run unit tests
+* *npm run test:integration* - Run integration tests
+* *npm run test:all* - Run Unit and Integration tests

db-scripts/create_database.sql

@@ -0,0 +1 @@
+CREATE DATABASE IF NOT EXISTS task_manager

docker-compose.yml

@@ -1,15 +1,29 @@
-version: '2'
+version: '2.1'
 services:
   app:
     build: .
+    command: npm run start:dev
     environment:
       - PORT=8080
-      - MONGO_URL=mongodb:27017
-    ports: 
+      - DB_HOST=mysql
+      - DB_PORT=3306
+      - DB_USER=root
+      - DB_PASSWORD=secret
+    ports:
       - "8080:8080"
+      - "5858:5858"
     links:
-      - mongodb
-  mongodb:
-    image: mongo:latest
+      - mysql
+    volumes:
+      - .:/app/
+    network_mode: bridge
+  mysql:
+    image: mysql:latest
+    environment:
+      - MYSQL_DATABASE=task_manager
+      - MYSQL_ROOT_PASSWORD=secret
     ports:
-      - "27017:27017"
+      - "3306:3306"
+    volumes:
+      - ./db-scripts:/docker-entrypoint-initdb.d
+    network_mode: bridge