add env config

Author: hirsch88

.env.example

@@ -0,0 +1,25 @@
+APP_NAME=qt-api
+APP_ENV=local
+APP_HOST=http://localhost
+APP_PORT=3000
+
+DEBUG=app*,api*,core*
+LOG_LEVEL=debug
+LOG_ADAPTER=debug
+
+DB_CLIENT=pg
+DB_CONNECTION=postgres://root:root@localhost:5432/my_database
+DB_POOL_MIN=0
+DB_POOL_MAX=7
+DB_MIGRATION_DIR=./src/database/migrations
+DB_MIGRATION_TABLE=version
+DB_SEEDS_DIR=./src/database/seeds
+
+
+AUTH0_HOST=https://w3tecch.auth0.com
+AUTH0_OAUTH=/oauth
+AUTH0_API=/api/v2
+AUTH0_CLIENT_ID=auth0_client_id
+AUTH0_CLIENT_SECRET=auth0_client_secret
+AUTH0_AUDIENCE=https://my.auth0.com/api/v2/
+AUTH0_GRANT_TYPE=client_credentials

.gitignore

@@ -10,6 +10,7 @@ node_modules/
 bower_components/
 npm-debug.log
 yarn-error.log
+.env
 
 # OS generated files #
 .DS_Store

README.md

@@ -50,7 +50,6 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * 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`.
-* With `npm run zip` it will generate the JavaScript source and pack them into to a deployable zip file into the dist folder.
 
 ### Docs
 * Run `npm run docs` to generate all doc files and serve it on `http://0.0.0.0:8080`

build/tasks/zip.js

@@ -1,9 +1,13 @@
-import * as _ from 'lodash';
-
-const config = require('./src/config');
-
-let databaseConfig = {};
-
-_.forOwn(_.clone(config), (value, key) => databaseConfig[`${key}`] = value.database);
-
-module.exports = databaseConfig;
+require('dotenv').config();
+
+module.exports = {
+    client: process.env.DB_CLIENT,
+    connection: process.env.DB_CONNECTION,
+    migrations: {
+        directory: process.env.DB_MIGRATION_DIR,
+        tableName: process.env.DB_MIGRATION_TABLE
+    },
+    seeds: {
+        directory: process.env.DB_SEEDS_DIR
+    }
+};

knexfile.ts

@@ -57,11 +57,13 @@
     "@types/bookshelf": "^0.8.38",
     "@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",
     "@types/helmet": "0.0.34",
     "@types/inversify": "^2.0.33",
     "@types/inversify-express-utils": "^2.0.0",
+    "@types/jest": "^19.2.2",
     "@types/knex": "0.0.47",
     "@types/lodash": "^4.14.63",
     "@types/morgan": "^1.7.32",
@@ -75,22 +77,9 @@
     "compression": "^1.6.2",
     "cors": "^2.8.1",
     "debug": "^2.6.0",
+    "dotenv": "^4.0.0",
     "express": "^4.14.0",
     "faker": "^3.1.0",
-    "helmet": "^3.4.0",
-    "inversify": "^4.1.0",
-    "inversify-express-utils": "^3.5.1",
-    "knex": "^0.12.7",
-    "lodash": "^4.17.4",
-    "morgan": "^1.7.0",
-    "pg": "^6.1.5",
-    "reflect-metadata": "^0.1.10",
-    "request": "^2.81.0",
-    "serve-favicon": "^2.4.2",
-    "ts-node": "^2.0.0",
-    "typescript": "^2.3.2",
-    "winston": "^2.3.1",
-    "@types/jest": "^19.2.2",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.2",
     "gulp-concat": "^2.6.1",
@@ -106,20 +95,31 @@
     "gulp-typedoc": "^2.0.2",
     "gulp-typescript": "^3.1.4",
     "gulp-zip": "^3.2.0",
+    "helmet": "^3.4.0",
     "http-server": "^0.9.0",
+    "inversify": "^4.1.0",
+    "inversify-express-utils": "^3.5.1",
     "jasmine-spec-reporter": "^4.0.0",
     "jest": "^19.0.2",
+    "knex": "^0.12.7",
+    "lodash": "^4.17.4",
+    "morgan": "^1.7.0",
     "nodemon": "^1.11.0",
     "path": "^0.12.7",
+    "pg": "^6.1.5",
+    "reflect-metadata": "^0.1.10",
     "request": "^2.79.0",
     "require-dir": "^0.3.1",
     "run-sequence": "^1.2.2",
+    "serve-favicon": "^2.4.2",
     "sqlite3": "^3.1.8",
     "ts-jest": "^19.0.11",
+    "ts-node": "^2.0.0",
     "tslint": "^4.3.1",
     "typedoc": "^0.5.5",
     "typescript": "^2.2.1",
-    "typings": "^2.1.0"
+    "typings": "^2.1.0",
+    "winston": "^2.3.1"
   },
   "jest": {
     "transform": {

package.json

@@ -20,9 +20,6 @@ export class User extends core.Bookshelf.Model<User> {
     public get LastName(): string { return this.get('lastName'); }
     public set LastName(value: string) { this.set({ id: value }); };
 
-    public get Username(): string { return this.get('username'); }
-    public set Username(value: string) { this.set({ id: value }); };
-
     public get Email(): string { return this.get('email'); }
     public set Email(value: string) { this.set({ id: value }); };
 

src/api/models/User.ts

@@ -1,3 +1,5 @@
+require('dotenv').config();
+
 process.env.DEBUG = 'console*';
 
 import * as Knex from 'knex';

src/config.ts

@@ -12,7 +12,7 @@ const log = new Log('core:Bootstrap');
 
 /**
  * This class helps us to create an express app very easy and moreover
- * to give us a better posibility to extend the bootstrap process
+ * to give us a better possibility to extend the bootstrap process
  *
  * @export
  * @class Bootstrap
@@ -30,12 +30,11 @@ export class Bootstrap {
      */
     static getApp(): express.Application {
         const app = express();
-        const config = Environment.getConfig();
 
         // Set serve configs for running it
-        app.set('host', config.server.host);
-        app.set('port', Bootstrap.normalizePort(config.server.port));
-        log.debug('app is created');
+        app.set('host', Environment.get('APP_HOST'));
+        app.set('port', Bootstrap.normalizePort(Environment.get<string>('PORT') || Environment.get<string>('APP_PORT')));
+        log.debug('app is defined');
         return app;
     }