Merge branch 'release/2.0.0-beta'

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

@@ -28,5 +28,8 @@ dist/
 
 # Generated source-code #
 src/**/*.js
+src/**/*.js.map
 test/**/*.js
+test/**/*.js.map
 coverage/
+!test/preprocessor.js

.vscode/launch.json

@@ -8,10 +8,10 @@
             "type": "node",
             "request": "launch",
             "name": "Debug",
-            "program": "${workspaceRoot}/dist/index.js",
+            "program": "${workspaceRoot}/src/app.js",
             "smartStep": true,
             "outFiles": [
-                "../dist/**/*.js"
+                "../src/**/*.js"
             ],
             "protocol": "inspector",
             "preLaunchTask": "build",

Procfile

@@ -1,16 +1,39 @@
 # 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 a feature complete server application.
+We like you to be focused on your business and not spending hours in project configuration.
+
+Try it!! We are happy to hear your feedback or any kind of 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/).
 - **Fast Database Building** with simple migration and seeding from [Knex](http://knexjs.org/).
 - **Simplified Database Query** with the ORM of [Knex](http://knexjs.org/) called [Bookshelf](http://bookshelfjs.org/).
 - **Clear Structure** with controllers, services, repositories, models, middlewares...
-- **Easy Exception Handling** with our own simple classes. You will see.
+- **Easy Exception Handling** with our own simple and easy to adopt logic. You will love it.
 - **Easy Data Seeding** with our own factories.
-- **Custom Commands** are also available in our setup and really easy to use.
+- **Custom Commands** are also available in our setup and really easy to use or even extend.
+- **Scaffolding Commands** will speed up your development tremendously as you should focus on business code and not scaffolding.
 - **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).
@@ -26,16 +49,18 @@ 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
-* Create new database. You will find the name in the .env files.
-* `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
+* Create a new database. You will find the name in the .env file.
+* Run `npm run setup` or enter the following commands manually:
+    * `yarn install` to install all dependencies and typings.
+    * `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 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/`).
+After you have installed all dependencies you can run the app.
+Enter `npm run serve` to start a local server using `nodemon`, which will watch for any file changes and will restart the sever according to these changes.
+The server address will be displayed to you as `http://0.0.0.0:3000`.
 
 ## Scripts / Tasks
 All script are defined in the package.json file, but the most important ones are listed here.
@@ -44,91 +69,111 @@ All script are defined in the package.json file, but the most important ones are
 * Install all dependencies with `yarn install`
 
 ### Linting
-* Run code analysis using `npm run lint`. This runs tslint.
-* There is also a vscode task for this called lint.
+* Run code quality analysis using `npm run lint`. This runs tslint.
+* There is also a vscode task for this called `lint`.
 
 ### Tests
-* Run the unit tests using `npm test`.
+* Run the unit tests using `npm test` (There is also a vscode task for this called `test`).
 * Run the black-box tests using `npm run test:black-box` and don't forget to start your application and your [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server).
-* There is also a vscode task for this called test.
 
 ### Running in dev mode
-* Run `npm run serve` to start nodemon with ts-node, which will serve your app.
+* Run `npm run serve` to start nodemon with ts-node, to serve the app.
 * The server address will be displayed to you as `http://0.0.0.0:3000`
 
 ### 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.
-* To start the builded app use `npm start`.
+* Run `npm run build` to generated all JavaScript files from the TypeScript sources (There is also a vscode task for this called `build`).
+* To start the builded app located in `dist` use `npm start`.
 
 ### Database
-* Run `npm run db:migrate` to migration the new schema to the database
-* Run `npm run db:migrate:rollback` to rollback one version
-* Run `npm run db:seed` to seed some data into the database
-* Run `npm run db:reset` to clean the database and migrate again
+* Run `npm run db:migrate` to migrate schema changes to the database
+* Run `npm run db:migrate:rollback` to rollback one migration
+* Run `npm run db:seed` to seed sample data into the database
+* Run `npm run db:reset` to rollback all migrations and migrate any migration again
 
 ### Console
-* To run your own created cli script enter `npm run console <command-name>`
+* To run your own created command enter `npm run console <command-name>`.
+* This list all your created commands `npm run console:help`.
+
+### Scaffolding Commands
+All the templates for the commands are located in `src/console/templates`.
+
+* `npm run console make:resource <file>` - Generates a controller, service, requests, repo, model and a migration with CRUD operations.
+* `npm run console make:controller <file>` - Generates a controller.
+* `npm run console make:service <file>` - Generates a service.
+* `npm run console make:repo <file>` - Generates a repository.
+* `npm run console make:model <file>` - Generates a model with the props and configurations.
+* `npm run console make:middleware <file>` - Generates a basic middleware.
+* `npm run console make:request <file>` - Generates a basic request.
+* `npm run console make:listener <file>` - Generates a basic listener.
+* `npm run console make:exception <file>` - Generates a basic exception.
+* `npm run console update:targets <file>` - Reads all the API files and generate a new `constants/Targets.ts` file out of it.
+
+**Example**
+```
+$ npm run console make:controller auth/auth
+// -> creates `api/controllers/auth/AuthController.ts
+
+$ npm run console make:model user
+// -> creates `api/models/User.ts
+```
 
 ## IoC
 Our IoC automatically looks through the `controllers`, `listeners` , `middlewares`, `services`,
-`repositories` and `models` for files to bind to our IoC - Container. So you have nothing to do.
+`repositories` and `models` folders in `src/api/` for files to bound automatically into the IoC - Container, so you have nothing to do.
 
-However it is very important to keep the naming, because otherwise our IoC will not find your
-created file.
+**However it is very important to keep the naming right, because otherwise our IoC will not find your
+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 by default `/api/v1`, but you can change this in the .env.example file.
+The route prefix is `/api` by default, but you can change this in the .env 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 |
+| **/api/info**   | Shows us the name, description and the version of the package.json |
+| **/api/docs**   | This is the Swagger UI with our API documentation |
+| **/status** | Shows a small monitor page for the server |
 
 ## 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/**                      | Source files |
+| **src/api/controllers/**      | REST API Controllers |
 | **src/api/exceptions/**       | Exceptions like 404 NotFound |
-| **src/api/listeners/**        | Event-Listeners |
+| **src/api/listeners/**        | Event listeners |
 | **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/api/repositories/**     | Repository / DB 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/config/**               | Configurations like database or logger |
 | **src/constants/**            | Global Constants |
-| **src/core/**                 | 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/core/**                 | The core framework |
+| **src/database/factories/**   | Model factories to generate database records |
+| **src/database/migrations/**  | Migrations scripts to build up the database schema |
+| **src/database/seeds/**       | Seed scripts to fake sample data into the 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 |
+| **src/types/** *.d.ts         | Custom type definitions and files that aren't on DefinitelyTyped |
+| **test**                      | Tests |
+| **test/black-box/** *.test.ts | Black-Box tests (like e2e) |
+| **test/unit/** *.test.ts      | Unit tests |
+| .env.example                  | 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)
+* [Auth0 Mock Server](https://github.com/hirsch88/auth0-mock-server) - Useful for black-box testing or faking an oAuth server
 
-## Documentations
+## Documentations of our main dependencies
 * [Express](https://expressjs.com/)
 * [Knex](http://knexjs.org/)
 * [Bookshelf](http://bookshelfjs.org/)
@@ -137,11 +182,11 @@ The route prefix is by default `/api/v1`, but you can change this in the .env.ex
 * [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
  [MIT](/LICENSE)
 
 ---
-Made with ♥ by Gery Hirschfeld ([@GeryHirschfeld1](https://twitter.com/GeryHirschfeld1)) and [contributors](https://github.com/w3tecch/express-typescript-boilerplate/graphs/contributors)
+Made with ♥ by w3tech ([w3tech](https://github.com/w3tecch)), Gery Hirschfeld ([@GeryHirschfeld1](https://twitter.com/GeryHirschfeld1)) and [contributors](https://github.com/w3tecch/express-typescript-boilerplate/graphs/contributors)

README.md

@@ -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\"'"
     }
 }