house cleaning

Author: hirsch88

.gitignore

@@ -7,7 +7,6 @@
 
 # Node files #
 node_modules/
-bower_components/
 npm-debug.log
 yarn-error.log
 .env
@@ -21,14 +20,6 @@ typings/
 
 # Dist #
 dist/
-releases/
-
-# Cordova #
-cordova/plugins/
-cordova/platforms/
-www/
-plugins/
-platforms/
 
 # IDE #
 .idea/
@@ -39,7 +30,3 @@ platforms/
 src/**/*.js
 test/**/*.js
 coverage/
-
-# Generated documentation #
-docs/
-old/

.travis.yml

@@ -2,7 +2,7 @@ language: node_js
 node_js:
   - "7.7.3"
 install:
-  - npm run install:dev
+  - npm run install
 scripts:
   - npm test
 notifications:

README.md

@@ -1,6 +1,16 @@
 # Express Typescript Boilerplate
 
-> Boilerplate for an restful express-application written in TypeScript
+Delightful building a RESTful API in TypeScript.
+- *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 Data Seeding* with our own factories.
+- *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.
 
 ## Getting Started
 ### Prerequisites
@@ -12,8 +22,8 @@
 ## Installing
 * `fork` this repo
 * `clone` your fork
-* `install:dev` to install all dependencies and typings
-* Create new database. You will find the name in the `src/config.ts` file.
+* `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
@@ -26,16 +36,14 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 ## Scripts / Commands
 ### Install
 * Install all dependencies with `yarn install`
-* Install all typings with `npm run install:typings`
-* To install all dependencies and typings use `npm run install:dev`
-* Remove not needed libraries with `npm run install:clean`
 
 ### Linting
 * Run code 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 black-box tests using `npm run test:black-box`.
 * There is also a vscode task for this called test.
 
 ### Running in dev mode
@@ -50,12 +58,14 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * There is also a vscode task for this called build.
 * To start the builded app use `npm start`.
 
-### Seed
-* Run `npm run db:seed` to seed some data into the database
-
-### Migration
+### 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
+
+### Console
+* To run your own created cli script enter `npm run console <command-name>`
 
 ## Related Projects
 * [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
@@ -68,6 +78,8 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * [Bookshelf Cheatsheet](http://ricostacruz.com/cheatsheets/bookshelf.html)
 * [Inversify](http://inversify.io/)
 * [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)
 
 ## License

build/paths.js

@@ -8,6 +8,5 @@ module.exports = {
     main: 'index.ts',
     src: 'src',
     test: 'test',
-    docs: 'docs',
     dist: 'dist'
 };

build/tasks/build.js

@@ -45,8 +45,7 @@ function transpiler(filePath, isTest, files) {
     let tsProject = !!isTest ? tsProjectTest : tsProjectSource;
     return gulp
         .src([
-            './typings/index.d.ts',
-            './typings_custom/**/*.d.ts',
+            './typings/*.d.ts',
             path.join(filePath, files)
         ])
         .pipe($.plumber({ errorHandler: $.notify.onError('Error: <%= error.message %>') }))

build/tasks/clean.js

@@ -9,7 +9,6 @@ const $ = require('gulp-load-plugins')({
 });
 
 gulp.task('clean', [
-    'clean:docs',
     'clean:build'
 ]);
 
@@ -20,7 +19,6 @@ gulp.task('clean:build', [
     'clean:test:map'
 ]);
 
-gulp.task('clean:docs', () => cleaner(paths.docs));
 gulp.task('clean:src:src', () => cleaner(paths.src, 'js'));
 gulp.task('clean:src:map', () => cleaner(paths.src, 'map'));
 gulp.task('clean:test:src', () => cleaner(paths.test, 'js'));

build/tasks/lint.js

@@ -23,7 +23,6 @@ function lint(files) {
 
 gulp.task('lint', () => lint([
     './typings/index.d.ts',
-    './typings_custom/**/*.d.ts',
     path.join(paths.src, '/**/*.ts'),
     path.join(paths.test, '/**/*.ts')
 ]));

build/util.js

@@ -1,46 +1,16 @@
 'use strict';
 
-const gulp = require('gulp'),
-    path = require('path'),
-    paths = require('./paths'),
-    $ = require('gulp-load-plugins')({
-        lazy: true
-    });
+const gulp = require('gulp');
+const notifier = require('node-notifier');
 
 var util = {
-    notify: notify,
-    getPkg: getPkg,
-    getJs: getJs,
-    buildConfig: buildConfig
+    notify: function notify(title, message) {
+        notifier.notify({
+            'title': title || 'Gulp',
+            'message': message || 'Please check your log or open your browser.',
+            icon: process.cwd() + '/icon.png'
+        });
+    }
 };
 
 module.exports = util;
-
-function getPkg() {
-    return require(path.join(process.cwd(), 'package.json'));
-}
-
-function notify(title, message) {
-    var notifier = require('node-notifier');
-    notifier.notify({
-        'title': title || 'Gulp',
-        'message': message || 'Please check your log or open your browser.',
-        icon: process.cwd() + '/icon.png'
-    });
-}
-
-function getJs(filename) {
-    return filename.replace('.ts', '.js');
-}
-
-function buildConfig(target) {
-    var env = $.util.env.environment || $.util.env.env || 'dev';
-    var configBase = './config';
-    var options = getPkg();
-    options.env = env;
-    return gulp
-        .src(path.join(configBase, env + '.json'))
-        .pipe($.rename('config.json'))
-        .pipe($.template(options))
-        .pipe(gulp.dest(target));
-}

knexfile.ts

@@ -1,5 +1,9 @@
 require('dotenv').config();
 
+/**
+ * This is the database configuration for the migrations and
+ * the seeders.
+ */
 module.exports = {
     client: process.env.DB_CLIENT,
     connection: process.env.DB_CONNECTION,

package.json

@@ -4,22 +4,17 @@
   "description": "Boilerplate for an restful express-application written in TypeScript.",
   "main": "src/index.ts",
   "scripts": {
-    "install:typings": "./node_modules/.bin/typings install",
-    "install:dev": "yarn install && npm run install:typings",
-    "install:clean": "npm prune && ./node_modules/.bin/typings prune",
-    "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts'",
-    "serve:debug": "npm run serve -- --debug=6666",
     "lint": "./node_modules/.bin/gulp lint",
     "test": "NODE_ENV=test ./node_modules/.bin/jest ./test/unit --verbose --coverage",
     "test:black-box": "NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i --verbose",
     "build": "./node_modules/.bin/gulp build",
     "clean": "./node_modules/.bin/gulp clean",
-    "zip": "./node_modules/.bin/gulp zip",
     "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'",
     "start": "node src/index.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
@@ -82,41 +77,32 @@
     "faker": "^4.1.0",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.2",
-    "gulp-concat": "^2.6.1",
-    "gulp-copy": "^1.0.0",
-    "gulp-filter": "^5.0.0",
-    "gulp-json-editor": "^2.2.1",
     "gulp-load-plugins": "^1.4.0",
     "gulp-notify": "^3.0.0",
     "gulp-plumber": "^1.1.0",
-    "gulp-rename": "^1.2.2",
     "gulp-sourcemaps": "^2.6.0",
     "gulp-tslint": "^8.0.0",
     "gulp-typescript": "^3.1.4",
-    "gulp-zip": "^4.0.0",
     "helmet": "^3.6.0",
     "inversify": "^4.1.0",
     "inversify-express-utils": "^3.5.1",
     "jest": "^20.0.3",
-    "knex": "^0.13.0",
+    "knex": "^0.12.0",
     "lodash": "^4.17.4",
     "morgan": "^1.7.0",
     "mysql": "^2.13.0",
     "nodemon": "^1.11.0",
     "path": "^0.12.7",
-    "pg": "^6.1.5",
     "reflect-metadata": "^0.1.10",
     "request": "^2.81.0",
     "request-promise": "^4.2.1",
     "require-dir": "^0.3.1",
     "run-sequence": "^1.2.2",
     "serve-favicon": "^2.4.3",
-    "sqlite3": "^3.1.8",
     "ts-jest": "^20.0.4",
     "ts-node": "^3.0.4",
     "tslint": "^5.2.0",
     "typescript": "^2.3.2",
-    "typings": "^2.1.0",
     "winston": "^2.3.1"
   },
   "jest": {