Merge branch 'feature/update_structure' into develop

Author: hirsch88

.env.example

@@ -4,13 +4,12 @@
 APP_NAME=express-typescript-boilerplate
 APP_ENV=local
 APP_HOST=http://localhost
-APP_URL_PREFIX=/api/v1
+APP_URL_PREFIX=/api
 APP_PORT=3000
 
 #
 # LOGGING
 #
-DEBUG=app*,api*,core*
 LOG_LEVEL=debug
 LOG_ADAPTER=winston
 

.gitignore

@@ -30,3 +30,4 @@ dist/
 src/**/*.js
 test/**/*.js
 coverage/
+!test/preprocessor.js

.vscode/launch.json

@@ -8,7 +8,7 @@
             "type": "node",
             "request": "launch",
             "name": "Debug",
-            "program": "${workspaceRoot}/dist/index.js",
+            "program": "${workspaceRoot}/dist/app.js",
             "smartStep": true,
             "outFiles": [
                 "../dist/**/*.js"

README.md

@@ -1,7 +1,29 @@
 # 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.
+> A delightful way to building a RESTful API with NodeJs & TypeScript.
+
+> An Node.js RESTful API boilerplate featuring
+[Express](https://expressjs.com/),
+[Inversify](http://inversify.io/),
+[Winston](https://github.com/winstonjs/winston),
+[TypeScript](https://www.typescriptlang.org/),
+[TsLint](http://palantir.github.io/tslint/),
+[@types](https://www.npmjs.com/~types),
+[Jest](https://facebook.github.io/jest/),
+[Swagger](http://swagger.io/),
+[validatejs](https://validatejs.org/),
+[knex](http://knexjs.org/) and
+[bookshelf](http://bookshelfjs.org/)
+by [w3tech](https://github.com/w3tecch)
+
+## Why
+Our main goal with this project is, that we have a feature complete server application.
+So you can focus more on main product and not spending hours for a project configuration.
+
+Just try it out and give us some feedback or whishes for new features.
+
+## Features
 - **Beautiful Syntax** thanks to the awesome annotations from [Inversify Express Utils](https://github.com/inversify/inversify-express-utils).
 - **Easy API Testing** with included black-box testing.
 - **Dependency Injection** done with the nice framework from [Inversify](http://inversify.io/).
@@ -26,12 +48,13 @@ A delightful way to building a RESTful API with NodeJs & TypeScript.
 ### Installing
 * `fork` this repo
 * `clone` your fork
-* `yarn install` to install all dependencies and typings
-* `cp .env.example .env` to copy the example .env file.
-* Create new database. You will find the name in the .env file.
-* `npm run db:migrate` to create the schema
-* `npm run db:seed` to insert some test data
-* `npm run serve` to start the dev server in another tab
+* `cp .env.example .env` to copy the example .env file and enter your database connection
+* Run `npm run setup` or enter the following commands manually:
+    * `yarn install` to install all dependencies and typings.
+    * Create new database. You will find the name in the .env file.
+    * `npm run db:migrate` to create the schema.
+    * `npm run db:seed` to insert some test data.
+* `npm run serve` to start the application.
 
 ### Running the app
 After you have installed all dependencies you can run the app.
@@ -100,13 +123,13 @@ Our IoC automatically looks through the `controllers`, `listeners` , `middleware
 `repositories` and `models` folders for files to bind to our IoC - Container, so you have nothing to do.
 
 **However it is very important to keep the naming right, because otherwise our IoC will not find your
-created file!!**
+created files!!**
 
 ## Using the debugger in VS Code
 Just set a breakpoint and hit `F5` in your Visual Studio Code.
 
 ## API Routes
-The route prefix is `/api/v1` by default, but you can change this in the .env file.
+The route prefix is `/api` by default, but you can change this in the .env file.
 
 | Route       | Description |
 | ----------- | ----------- |
@@ -160,7 +183,7 @@ The route prefix is `/api/v1` by default, but you can change this in the .env fi
 * [Inversify Express Utils](https://github.com/inversify/inversify-express-utils)
 * [class-validator](https://github.com/pleerock/class-validator)
 * [Jest](http://facebook.github.io/jest/)
-* [Auth0 API Documentation](https://auth0.com/docs/api/management/v2#!/Users/get_users)
+* [Auth0 API Documentation](https://auth0.com/docs/api/management/v2)
 * [swagger Documentation](http://swagger.io/)
 
 ## License

knexfile.ts

@@ -1,4 +1,5 @@
-require('dotenv').config();
+import * as dotenv from 'dotenv';
+dotenv.config();
 
 /**
  * This is the database configuration for the migrations and

nodemon.json

@@ -4,7 +4,7 @@
         "ts": "./node_modules/.bin/ts-node"
     },
     "events": {
-        "start": "./node_modules/.bin/tslint -c ./tslint.json 'src/**/*.ts' --format stylish --force",
+        "start": "./node_modules/.bin/tslint -c ./tslint.json -t stylish 'src/**/*.ts'",
         "restart": "osascript -e 'display notification \"restarting server\" with title \"node.js application\"'"
     }
 }

package.json

@@ -2,29 +2,33 @@
   "name": "express-typescript-boilerplate",
   "version": "1.7.0",
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
-  "main": "src/index.ts",
+  "main": "src/app.ts",
   "scripts": {
-    "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",
+    "banner": "./node_modules/.bin/ts-node --fast ./src/console/lib/banner.ts",
+    "pretest": "./node_modules/.bin/tslint -c ./tslint.json -t stylish './test/unit/**/*.ts'",
+    "test:pretty": "npm run test -- --verbose",
+    "test:coverage": "npm run test -- --coverage",
+    "pretest:black-box": "./node_modules/.bin/tslint -c ./tslint.json -t stylish './test/black-box/**/*.ts'",
+    "test:black-box": "npm run banner test && NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i",
+    "test:black-box:pretty": "npm run test:black-box -- --verbose",
     "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/rimraf ./dist",
     "copy:assets": "npm run copy:swagger && npm run copy:public",
     "copy:swagger": "./node_modules/.bin/copyup ./src/api/swagger.json ./dist",
     "copy:public": "./node_modules/.bin/copyup ./src/public/* ./dist",
-    "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:migrate": "npm run banner migrate && ./node_modules/.bin/knex migrate:latest",
+    "db:migrate:rollback": "npm run banner rollback && ./node_modules/.bin/knex migrate:rollback",
+    "db:seed": "npm run banner seed && ./node_modules/.bin/knex seed:run",
     "db:reset": "npm run console db:reset",
     "console": "./node_modules/.bin/ts-node --fast ./src/console/commander.ts",
     "console:dev": "./node_modules/.bin/ts-node ./src/console/commander.ts",
     "console:help": "./node_modules/.bin/ts-node --fast ./src/console/commander.ts --help",
-    "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json' --watch '.env'",
-    "start": "node dist/index.js"
+    "setup": "yarn install && npm run db:migrate && npm run db:seed",
+    "serve": "npm run banner serve && ./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json' --watch '.env'",
+    "test": "npm run banner test && NODE_ENV=test ./node_modules/.bin/jest ./test/unit",
+    "build": "npm run banner build && npm run lint && npm run clean:dist && npm run transpile && npm run copy:assets",
+    "start": "node dist/app.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
   "engines": {
@@ -57,9 +61,9 @@
     "@types/bluebird": "^3.5.4",
     "@types/body-parser": "^1.16.3",
     "@types/bookshelf": "^0.9.1",
+    "@types/chalk": "^0.4.31",
     "@types/commander": "^2.9.0",
     "@types/cors": "^2.8.1",
-    "@types/debug": "0.0.29",
     "@types/dotenv": "^4.0.0",
     "@types/express": "^4.0.35",
     "@types/faker": "^4.1.0",
@@ -82,16 +86,17 @@
     "body-parser": "^1.17.2",
     "bookshelf": "^0.10.3",
     "bookshelf-camelcase": "^1.1.4",
+    "chalk": "^1.1.3",
     "class-validator": "^0.7.0",
     "commander": "^2.9.0",
     "compression": "^1.6.2",
     "copyfiles": "^1.2.0",
     "cors": "^2.8.1",
-    "debug": "^2.6.8",
     "dotenv": "^4.0.0",
     "express": "^4.15.3",
     "express-status-monitor": "^0.1.9",
     "faker": "^4.1.0",
+    "figlet": "^1.2.0",
     "glob": "^7.1.2",
     "handlebars": "^4.0.10",
     "helmet": "^3.6.1",
@@ -125,7 +130,7 @@
   },
   "jest": {
     "transform": {
-      ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js"
+      ".(ts|tsx)": "<rootDir>/test/preprocessor.js"
     },
     "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
     "moduleFileExtensions": [

src/api/controllers/UserController.ts

@@ -8,23 +8,19 @@
 
 import { inject, named } from 'inversify';
 import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response, Request } from 'inversify-express-utils';
-import { myExpress } from 'my-express';
+import { app } from '../../app';
+import { Types, Targets } from '../../constants';
 import { UserService } from '../services/UserService';
-import { Types } from '../../constants/Types';
-import { Service, Middleware } from '../../constants/Targets';
-import { AuthenticateMiddleware } from '../middlewares/AuthenticateMiddleware';
-import { PopulateUserMiddleware } from '../middlewares/PopulateUserMiddleware';
-import { ioc } from '../../core/IoC';
 
 // Get middlewares
-const authenticate = ioc.Container.getNamed<AuthenticateMiddleware>(Types.Middleware, Middleware.AuthenticateMiddleware);
-const populateUser = ioc.Container.getNamed<PopulateUserMiddleware>(Types.Middleware, Middleware.PopulateUserMiddleware);
+const populateUser = app.IoC.getNamed<interfaces.Middleware>(Types.Middleware, Targets.Middleware.PopulateUserMiddleware);
+const authenticate = app.IoC.getNamed<interfaces.Middleware>(Types.Middleware, Targets.Middleware.AuthenticateMiddleware);
 
 
 @Controller('/users', authenticate.use)
 export class UserController {
 
-    constructor( @inject(Types.Service) @named(Service.UserService) private userService: UserService) { }
+    constructor( @inject(Types.Service) @named(Targets.Service.UserService) private userService: UserService) { }
 
     @Get('/')
     public async findAll( @Response() res: myExpress.Response): Promise<any> {

src/api/listeners/user/UserAuthenticatedListener.ts

@@ -1,22 +1,21 @@
 import { inject, named } from 'inversify';
-import { Types } from '../../../constants/Types';
-import { Core } from '../../../core/Targets';
-import { Log } from '../../../core/log/';
+import { Types, Core } from '../../../constants';
+import { Logger as LoggerType } from '../../../core/Logger';
 
 
-export class UserAuthenticatedListener {
+export class UserAuthenticatedListener implements interfaces.Listener {
 
-    static Event = Symbol('UserAuthenticatedListener');
+    public static Event = Symbol('UserAuthenticatedListener');
 
-    public log: Log;
+    public log: LoggerType;
 
     constructor(
-        @inject(Types.Core) @named(Core.Log) Logger: typeof Log
+        @inject(Types.Core) @named(Core.Logger) Logger: typeof LoggerType
     ) {
-        this.log = new Logger('api:listeners:UserAuthenticatedListener');
+        this.log = new Logger(__filename);
     }
 
-    public run(user: any): void {
+    public act(user: any): void {
         this.log.info('Receive event UserAuthenticatedListener', user);
     }
 

src/api/listeners/user/UserCreatedListener.ts

@@ -1,25 +1,22 @@
 import { inject, named } from 'inversify';
-import { Types } from '../../../constants/Types';
-import { Core } from '../../../core/Targets';
-import { Log } from '../../../core/log/';
+import { Types, Core } from '../../../constants';
+import { Logger as LoggerType } from '../../../core/Logger';
 
-const log = new Log('api:listeners:UserCreated');
 
+export class UserCreatedListener implements interfaces.Listener {
 
-export class UserCreatedListener {
+    public static Event = Symbol('UserCreated');
 
-    static Event = Symbol('UserCreated');
-
-    public log: Log;
+    public log: LoggerType;
 
     constructor(
-        @inject(Types.Core) @named(Core.Log) Logger: typeof Log
+        @inject(Types.Core) @named(Core.Logger) Logger: typeof LoggerType
     ) {
-        this.log = new Logger('api:listeners:UserCreatedListener');
+        this.log = new Logger(__filename);
     }
 
-    public run(user: any): void {
-        log.info('Receive event UserCreated', user);
+    public act(user: any): void {
+        this.log.info('Receive event UserCreated', user);
     }
 
 }