Implement some best pratices

Makefile

@@ -1,3 +1,5 @@
+include ./.env
+
 .PHONY: build check clean help lint install start test test-coverage
 
 .DEFAULT_GOAL := help
@@ -18,7 +20,7 @@ clean: ## clean artifacts
 
 help: ## provide help to you
 	@echo "Please use \`make <target>' where <target> is one of"
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "	\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	@echo "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\1:\2/' | column -c2 -t -s :)"
 
 lint: ## check the quality code and ES6 integration
 	@echo " > Linting the source"
@@ -33,14 +35,14 @@ install: ## install dependencies
 start: ## start the web server
 	@echo " > Starting the project"
 	@$(MAKE) -s build
-	@export PORT=$(PORT) && export NODE_ENV=$(ENVIRONMENT) && node $(BUILD_DIRECTORY)/index.js
+	@node $(BUILD_DIRECTORY)/index.js
 
 test: ## launch tests
 	@echo " > Testing the project"
 	@$(MAKE) -s build
-	@export PORT=$(PORT) && export NODE_ENV=$(ENVIRONMENT_TEST) && $(MOCHA) --require babel-core/register --recursive --exit
+	@export PORT=0 && export NODE_ENV=test && $(MOCHA) --require babel-core/register --recursive --exit
 
 test-coverage: ## launch tests with coverage
 	@echo " > Testing with coverage"
 	@$(MAKE) -s build
-	@export PORT=$(PORT) && export NODE_ENV=$(ENVIRONMENT_TEST) && $(BABEL_NODE) $(BABEL_ISTANBUL) cover $(MOCHA_) --report html --report text --check-coverage -- --recursive
+	@export PORT=0 && export NODE_ENV=test && $(BABEL_NODE) $(BABEL_ISTANBUL) cover $(MOCHA_) --report html --report text --check-coverage -- --recursive

README.md

@@ -23,7 +23,7 @@ Run tests to verify the installation.
 
 ### Run the project
 
-The project is available on [http://127.0.0.1:3000](http://127.0.0.1:3000).
+The project is available on [http://127.0.0.1:<PORT>](http://127.0.0.1:<PORT>).
 
 `$ make start`
 

config/default.json

@@ -0,0 +1,5 @@
+{
+  "app": {
+    "name": "expressjs-starter-pack"
+  }
+}

package.json

@@ -12,9 +12,11 @@
   "dependencies": {
     "body-parser": "^1.17.1",
     "cluster": "^0.7.7",
+    "config": "^1.27.0",
     "cors": "^2.8.4",
     "express": "^4.15.2",
     "express-validator": "^4.3.0",
+    "normalize-port": "^1.0.0",
     "winston": "^2.3.1"
   },
   "devDependencies": {

src/app.js

@@ -4,7 +4,6 @@ import bodyParser from 'body-parser';
 import cors from 'cors';
 import express from 'express';
 import expressValidator from 'express-validator';
-import config from './config/index';
 import controllers from './controller/index';
 import logger from './helper/logger';
 
@@ -33,8 +32,4 @@ app.use((err, req, res, next) => {
   });
 });
 
-const listener = app.listen(config.app.port, () => {
-  logger.info(`Listening on port ${listener.address().port}`);
-});
-
-export default listener;
+export default app;

src/helper/logger.js

@@ -1,7 +1,6 @@
 /* eslint no-underscore-dangle: ["error", { "allow": ["_logger"] }] */
 
 import winston from 'winston';
-import config from './../config/index';
 
 class Logger {
   constructor() {
@@ -12,23 +11,23 @@ class Logger {
       ],
     });
 
-    if (config.app.environment === 'local') {
+    if (process.env.NODE_ENV === 'local') {
       this._logger.add(winston.transports.Console, {
         level: 'info',
         timestamp: () => (new Date().toISOString()),
-        formatter: options => (`${options.timestamp()} ${winston.config.colorize(options.level, options.level.toUpperCase())} ${(options.message ? options.message : '')} ${(options.meta && Object.keys(options.meta).length ? `\n\t${JSON.stringify(options.meta)}` : '')}`),
+        formatter: options => (`[${winston.config.colorize(options.level, options.level.toUpperCase())}][${options.timestamp()}] ${(options.message ? options.message : '')} ${(options.meta && Object.keys(options.meta).length ? `\n\t${JSON.stringify(options.meta)}` : '')}`),
       });
     }
   }
 
   info(message, meta) {
-    if (config.app.environment === 'local') {
+    if (process.env.NODE_ENV === 'local') {
       this._logger.log('info', message, meta);
     }
   }
 
   error(message, meta) {
-    if (config.app.environment === 'local') {
+    if (process.env.NODE_ENV === 'local') {
       this._logger.log('error', message, meta);
     }
   }

src/index.js

@@ -25,6 +25,6 @@ if (cluster.isMaster) {
     cluster.fork();
   });
 } else { // Code to run if we're in a worker process
-  require('./app');
+  require('./server');
   logger.info(`Worker ${cluster.worker.id} running!`);
 }

src/server.js

@@ -0,0 +1,15 @@
+import http from 'http';
+import normalizePort from 'normalize-port';
+import app from './app';
+import logger from './helper/logger';
+
+const port = normalizePort(process.env.PORT || '3000');
+
+/**
+ * Create HTTP server.
+ */
+const server = http.createServer(app).listen(port, () => {
+  logger.info(`Listening on port ${server.address().port}`);
+});
+
+export default server;

test/app.js

@@ -1,6 +1,6 @@
 import chai from 'chai';
 import chaiHttp from 'chai-http';
-import server from './../src/app';
+import server from './../src/server';
 
 const should = chai.should();
 

test/controller/index.js

@@ -1,6 +1,6 @@
 import chai from 'chai';
 import chaiHttp from 'chai-http';
-import server from './../../src/app';
+import server from './../../src/server';
 
 const should = chai.should();
 

test/controller/v1/resource.js

@@ -1,6 +1,6 @@
 import chai from 'chai';
 import chaiHttp from 'chai-http';
-import server from './../../../src/app';
+import server from './../../../src/server';
 
 const should = chai.should();