Add monitoring, update readme and house cleaning

Author: hirsch88

.vscode/launch.json

@@ -7,11 +7,13 @@
         {
             "type": "node",
             "request": "launch",
-            "name": "Launch App",
-            "stopOnEntry": true,
-            "program": "${workspaceRoot}/src/index.ts",
-            "cwd": "${workspaceRoot}",
-            "sourceMaps": true,
+            "name": "Debug",
+            "program": "${workspaceRoot}/dist/index.js",
+            "smartStep": true,
+            "outFiles": [
+                "../dist/**/*.js"
+            ],
+            "protocol": "inspector",
             "preLaunchTask": "build",
             "env": {
                 "NODE_ENV": "development"

.vscode/settings.json

@@ -1,9 +1,4 @@
 {
     "typescript.tsdk": "./node_modules/typescript/lib",
-    "files.exclude": {
-        "src/**/*.js": false,
-        "test/**/*.js": true
-    },
-    "vsicons.presets.angular": false,
     "cSpell.enabled": true
 }

.vscode/tasks.json

@@ -22,22 +22,6 @@
             "args": [
                 "test"
             ]
-        },
-        {
-            // "npm run lint"
-            "taskName": "lint",
-            "args": [
-                "run",
-                "lint"
-            ]
-        },
-        {
-            // "npm run clean"
-            "taskName": "clean",
-            "args": [
-                "run",
-                "clean"
-            ]
         }
     ]
 }

README.md

@@ -1,4 +1,5 @@
-# Express Typescript Boilerplate [![Build Status](https://travis-ci.org/w3tecch/express-typescript-boilerplate.svg?branch=master)](https://travis-ci.org/w3tecch/express-typescript-boilerplate)
+# Express Typescript Boilerplate
+[![Dependency Status](https://david-dm.org/w3tecch/express-typescript-boilerplate/status.svg?style=flat)](https://david-dm.org/w3tecch/express-typescript-boilerplate) [![Build Status](https://travis-ci.org/w3tecch/express-typescript-boilerplate.svg?branch=master)](https://travis-ci.org/w3tecch/express-typescript-boilerplate)
 
 A delightful way to building a RESTful API with NodeJs & TypeScript.
 - **Beautiful Syntax** thanks to the awesome annotations from [Inversify Express Utils](https://github.com/inversify/inversify-express-utils).
@@ -12,6 +13,8 @@ A delightful way to building a RESTful API with NodeJs & TypeScript.
 - **Custom Commands** are also available in our setup and really easy to use.
 - **Smart Validation** thanks to [class-validator](https://github.com/pleerock/class-validator) with some nice annotations.
 - **API Documentation** thanks to [swagger](http://swagger.io/).
+- **API Monitoring** thanks to [express-status-monitor](https://github.com/RafalWilinski/express-status-monitor).
+- **Integrated Testing Tool** thanks to [Wallaby.js](https://wallabyjs.com/)
 
 ## Getting Started
 ### Prerequisites
@@ -20,7 +23,7 @@ A delightful way to building a RESTful API with NodeJs & TypeScript.
     * on Windows use [chocolatey](https://chocolatey.org/) `choco install nodejs`
 * Install yarn globally `npm install yarn -g`
 
-## Installing
+### Installing
 * `fork` this repo
 * `clone` your fork
 * `yarn install` to install all dependencies and typings
@@ -29,12 +32,14 @@ A delightful way to building a RESTful API with NodeJs & TypeScript.
 * `npm run db:seed` to insert some test data
 * `npm run serve` to start the dev server in another tab
 
-## Running the app
+### Running the app
 After you have installed all dependencies you can now run the app.
 Run `npm run serve` to start a local server using `nodemon` which will watch for changes and then will restart the sever.
 The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv6, if you're using `express` server, then it's `http://[::1]:3000/`).
 
-## Scripts / Commands
+## Scripts / Tasks
+All script are defined in the package.json file, but the most important ones are listed here.
+
 ### Install
 * Install all dependencies with `yarn install`
 
@@ -51,9 +56,6 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * Run `npm run serve` to start nodemon with ts-node, which will serve your app.
 * The server address will be displayed to you as `http://0.0.0.0:3000`
 
-### Cleaning the project
-* Run `npm run clean` to remove all generated JavaScript files.
-
 ### Building the project and run it
 * Run `npm run build` to generated all JavaScript files from your TypeScript sources. After this step you can deploy the app on any server.
 * There is also a vscode task for this called build.
@@ -68,7 +70,51 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 ### Console
 * To run your own created cli script enter `npm run console <command-name>`
 
+## Using the debugger in VS Code
+Just set a breakpoint and hit `F5` in your Visual Studio Code.
+
+## API Routes
+The route prefix is by default `/api/v1`, but you can change this in the .env.example file.
+
+| Route       | Description |
+| ----------- | ----------- |
+| **/info**   | Shows us the name, description and the version of the package.json |
+| **/docs**   | This is the Swagger UI with our API Documentation |
+| **/status** | Shows a small monitor app for our API |
+
+## Project Structure
+
+| Name                          | Description |
+| ----------------------------- | ----------- |
+| **.vscode/**                  | VSCode tasks, launch configuration and some other settings |
+| **build/**                    | Task Runner configurations and tasks |
+| **dist/**                     | Compiled source files will be placed here |
+| **src/**                      | Source-Files |
+| **src/api/controllers/**      | REST-API - Controllers |
+| **src/api/exceptions/**       | Exceptions like 404 NotFound |
+| **src/api/middlewares/**      | Express Middlewares like populateUser |
+| **src/api/models/**           | Bookshelf Models |
+| **src/api/repositories/**     | Repository Layer |
+| **src/api/requests/**         | Request Bodys with Validations |
+| **src/api/services/**         | Service Layer |
+| **src/api/** swagger.json     | Swagger Documentation |
+| **src/console/**              | Command Line scripts |
+| **src/constants/**            | Global Constants |
+| **src/core/**                 | All the libraries configurations and our small framework |
+| **src/database/factories/**   | Model Factories to generate database records |
+| **src/database/migrations/**  | Migrations scripts to build up our database schema |
+| **src/database/seeds/**       | Seed scripts to fake some data into our database |
+| **src/public/**               | Static assets (fonts, css, js, img). |
+| **src/types/** *.d.ts         | Custom Type Definitions and files that aren't on DefinitelyTyped |
+| **test**                      | All our test cases |
+| **test/setup/**               | Some setup scripts to create a needed test environment |
+| **test/black-box/** *.test.ts | Black-Box Testing (like e2e) |
+| **test/unit/** *.test.t       | Unit Testing |
+| .env.example                  | All environment configurations |
+| knexfile.ts                   | This file is used for the migrations and seed task of knex |
+
 ## Related Projects
+* [Microsoft/TypeScript-Node-Starter](https://github.com/Microsoft/TypeScript-Node-Starter) - A starter template for TypeScript and Node with a detailed README describing how to use the two together.
 * [express-graphql-typescript-boilerplate](https://github.com/w3tecch/express-graphql-typescript-boilerplate) - A starter kit for building amazing GraphQL API's with TypeScript and express by @w3tecch
 * [aurelia-typescript-boilerplate](https://github.com/w3tecch/aurelia-typescript-boilerplate) - An Aurelia starter kit with TypeScript
 * [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server)

build/tasks/build.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const gulp = require('gulp');
+const path = require('path');
+const paths = require('../paths');
+const $ = require('gulp-load-plugins')({
+    lazy: true
+});
+
+
+gulp.task('clean:dist', () => {
+    return gulp
+        .src(paths.dist, {
+            read: false
+        })
+        .pipe($.clean());
+});

build/tasks/clean-dist.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const gulp = require('gulp');
+const path = require('path');
+const paths = require('../paths');
+const $ = require('gulp-load-plugins')({
+    lazy: true
+});
+
+
+gulp.task('copy:assets', () => {
+    return gulp
+        .src([
+            path.join(paths.src, '/public/**/*'),
+            path.join(paths.src, '/**/*.json')
+        ], { base: paths.src })
+        .pipe(gulp.dest(paths.dist));
+});

build/tasks/clean.js

@@ -4,21 +4,23 @@
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
   "main": "src/index.ts",
   "scripts": {
-    "lint": "./node_modules/.bin/tslint -c ./tslint.json 'src/**/*.ts' --format stylish --force",
     "test": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit",
     "test:pretty": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --verbose",
     "test:coverage": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --coverage",
     "test:black-box": "NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i",
     "test:black-box:pretty": "NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i --verbose",
-    "build": "./node_modules/.bin/gulp build",
-    "clean": "./node_modules/.bin/gulp clean",
+    "lint": "./node_modules/.bin/tslint -c ./tslint.json -p tsconfig.json 'src/**/*.ts' --format stylish",
+    "build": "npm run lint && npm run clean:dist && npm run transpile && npm run copy:assets",
+    "transpile": "./node_modules/.bin/tsc",
+    "clean:dist": "./node_modules/.bin/gulp clean:dist",
+    "copy:assets": "./node_modules/.bin/gulp copy:assets",
     "db:migrate": "./node_modules/.bin/knex migrate:latest",
     "db:migrate:rollback": "./node_modules/.bin/knex migrate:rollback",
     "db:seed": "./node_modules/.bin/knex seed:run",
     "db:reset": "npm run console db:reset",
     "console": "./node_modules/.bin/ts-node ./src/console/commander.ts",
     "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json'",
-    "start": "node src/index.js"
+    "start": "node dist/index.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
   "engines": {
@@ -78,14 +80,11 @@
     "debug": "^2.6.8",
     "dotenv": "^4.0.0",
     "express": "^4.15.3",
+    "express-status-monitor": "^0.1.9",
     "faker": "^4.1.0",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.2",
     "gulp-load-plugins": "^1.4.0",
-    "gulp-plumber": "^1.1.0",
-    "gulp-sourcemaps": "^2.6.0",
-    "gulp-tslint": "^8.0.0",
-    "gulp-typescript": "^3.1.4",
     "helmet": "^3.6.1",
     "inversify": "^4.1.0",
     "inversify-express-utils": "^3.5.1",

build/tasks/copy-assets.js

@@ -0,0 +1,31 @@
+import * as express from 'express';
+import * as monitor from 'express-status-monitor';
+const swaggerUi = require('swagger-ui-express');
+import { Controller, Get, Response, Request } from 'inversify-express-utils';
+import { injectable } from 'inversify';
+import { Environment } from '../../core/Environment';
+
+/**
+ * HomeController is a public controller to give some
+ * information about this api
+ */
+@injectable()
+@Controller('')
+export class ApiController {
+
+    @Get('/info')
+    public getInfo( @Response() res: express.Response): any {
+        const pkg = require('../../../package.json');
+        return res.json({
+            name: pkg.name,
+            version: pkg.version,
+            description: pkg.description
+        });
+    }
+
+    @Get('/status')
+    public getStatus( @Request() req: express.Request, @Response() res: express.Response): any {
+        return monitor().pageRoute(req, res);
+    }
+
+}