Merge pull request #442 from kunalkapadia/develop

Update node and remove gulp, babel.

Author: kunalkapadia

.istanbul.yml

@@ -1,6 +1,6 @@
 verbose: false
 instrumentation:
-  excludes: ['dist/**', 'coverage/**', 'gulpfile.babel.js']
+  excludes: ['dist/**', 'coverage/**', 'index.js']
   include-all-sources: true
 reporting:
     print: summary

.travis.yml

@@ -1,8 +1,7 @@
 language: node_js
 node_js:
-  - "4.8"
-  - "6.10"
-  - "7.6"
+  - "8.10"
+  - "9.9"
 services:
   - mongodb
 cache:
@@ -14,3 +13,6 @@ script:
   - yarn test:check-coverage
 after_script:
   - yarn report-coverage
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.5.1
+  - export PATH=$HOME/.yarn/bin:$PATH

Dockerfile

@@ -1,5 +1,5 @@
-# take default image of node boron i.e  node 6.x
-FROM node:6.10.1
+# Use latest node version 8.x
+FROM node:8.10.0
 
 MAINTAINER Kunal Kapadia <[email protected]>
 

README.md

@@ -1,18 +1,18 @@
 # Express & mongoose REST API Boilerplate in ES6 with Code Coverage [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
 
-[![Build Status](https://img.shields.io/travis/KunalKapadia/express-mongoose-es6-rest-api/master.svg?style=flat-square)](https://travis-ci.org/KunalKapadia/express-mongoose-es6-rest-api)
-[![Coverage Status](https://img.shields.io/coveralls/KunalKapadia/express-mongoose-es6-rest-api/master.svg?style=flat-square)](https://coveralls.io/github/KunalKapadia/express-mongoose-es6-rest-api?branch=master)
-[![Code Climate](https://img.shields.io/codeclimate/github/KunalKapadia/express-mongoose-es6-rest-api.svg?style=flat-square)](https://codeclimate.com/github/KunalKapadia/express-mongoose-es6-rest-api)
-[![bitHound Overall Score](https://www.bithound.io/github/KunalKapadia/express-es6-rest-api-starter/badges/score.svg)](https://www.bithound.io/github/KunalKapadia/express-es6-rest-api-starter)
-[![bitHound Dependencies](https://www.bithound.io/github/KunalKapadia/express-mongoose-es6-rest-api/badges/dependencies.svg)](https://www.bithound.io/github/KunalKapadia/express-mongoose-es6-rest-api/master/dependencies/npm)
+[![Build Status](https://img.shields.io/travis/kunalkapadia/express-mongoose-es6-rest-api/master.svg?style=flat-square)](https://travis-ci.org/kunalkapadia/express-mongoose-es6-rest-api)
+[![Coverage Status](https://img.shields.io/coveralls/kunalkapadia/express-mongoose-es6-rest-api/master.svg?style=flat-square)](https://coveralls.io/github/kunalkapadia/express-mongoose-es6-rest-api?branch=master)
+[![Code Climate](https://img.shields.io/codeclimate/github/kunalkapadia/express-mongoose-es6-rest-api.svg?style=flat-square)](https://codeclimate.com/github/kunalkapadia/express-mongoose-es6-rest-api)
+[![bitHound Overall Score](https://www.bithound.io/github/kunalkapadia/express-es6-rest-api-starter/badges/score.svg)](https://www.bithound.io/github/kunalkapadia/express-es6-rest-api-starter)
+[![bitHound Dependencies](https://www.bithound.io/github/kunalkapadia/express-mongoose-es6-rest-api/badges/dependencies.svg)](https://www.bithound.io/github/kunalkapadia/express-mongoose-es6-rest-api/master/dependencies/npm)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)
 [![MIT License](https://img.shields.io/npm/l/stack-overflow-copy-paste.svg?style=flat-square)](http://opensource.org/licenses/MIT)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![Support via Paypal](https://img.shields.io/badge/support-paypal-yellowgreen.svg?style=flat-square)](https://www.paypal.me/KunalKapadia)
 
-[![Code Sponsor](https://app.codesponsor.io/embed/J9YBdeLoqYqrG8tmMKF4p6Pv/KunalKapadia/express-mongoose-es6-rest-api.svg)](https://app.codesponsor.io/link/J9YBdeLoqYqrG8tmMKF4p6Pv/KunalKapadia/express-mongoose-es6-rest-api)
+[![Code Sponsor](https://app.codesponsor.io/embed/J9YBdeLoqYqrG8tmMKF4p6Pv/kunalkapadia/express-mongoose-es6-rest-api.svg)](https://app.codesponsor.io/link/J9YBdeLoqYqrG8tmMKF4p6Pv/kunalkapadia/express-mongoose-es6-rest-api)
 
-# [![Express ES6 REST API Starter](https://cloud.githubusercontent.com/assets/4172932/12660610/90f5b856-c63a-11e5-878e-c9f0bbf33090.jpg)](https://github.com/KunalKapadia/express-mongoose-es6-rest-api)
+# [![Express ES6 REST API Starter](https://cloud.githubusercontent.com/assets/4172932/12660610/90f5b856-c63a-11e5-878e-c9f0bbf33090.jpg)](https://github.com/kunalkapadia/express-mongoose-es6-rest-api)
 
 ## Overview
 
@@ -44,7 +44,7 @@ Heavily inspired from [Egghead.io - How to Write an Open Source JavaScript Libra
 
 Clone the repo:
 ```sh
-git clone [email protected]:KunalKapadia/express-mongoose-es6-rest-api.git
+git clone [email protected]:kunalkapadia/express-mongoose-es6-rest-api.git
 cd express-mongoose-es6-rest-api
 ```
 
@@ -147,12 +147,24 @@ Get code coverage summary on executing `yarn test`
 
 ## Docker
 
+#### Using Docker Compose for Development
 ```sh
-# For Development
 # service restarts on file change
-1. bash bin/development.sh
+bash bin/development.sh
 ```
 
+#### Building and running without Docker Compose
+```bash
+# To use this option you need to make sure mongodb is listening on port 27017
+
+# Build docker 
+docker build -t express-mongoose-es6-rest-api .
+
+# Run docker
+docker run -p 4040:4040 express-mongoose-es6-rest-api
+```
+
+
 ## A Boilerplate-only Option
 
 If you would prefer not to use any of our tooling, delete the following files from the project: `package.json`, `gulpfile.babel.js`, `.eslintrc` and `.travis.yml`. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.
@@ -166,7 +178,7 @@ If you would prefer not to use any of our tooling, delete the following files fr
 Contributions, questions and comments are all welcome and encouraged. For code contributions submit a pull request with unit test.
 
 ## License
-This project is licensed under the [MIT License](https://github.com/KunalKapadia/express-mongoose-es6-rest-api/blob/master/LICENSE)
+This project is licensed under the [MIT License](https://github.com/kunalkapadia/express-mongoose-es6-rest-api/blob/master/LICENSE)
 
 ## Support Development
 If this project saved your valuable time in getting your service up, and you feel like buying me coffee, you can donate either at my BTC address: `1LkW5UoERR1jjJsChMheKuo6vn95x2mzWg` or at [![Support via Paypal](https://img.shields.io/badge/support-paypal-yellowgreen.svg?style=flat-square)](https://www.paypal.me/KunalKapadia)
@@ -175,5 +187,5 @@ Your support is greatly appreciated.
 
 ## Meta
 
-Kunal Kapadia – [@kunalkapadia12](https://twitter.com/KunalKapadia12) – [email protected]
+Kunal Kapadia – [@kunalkapadia12](https://twitter.com/kunalkapadia12) – [email protected]
 

config/config.js

@@ -1,4 +1,4 @@
-import Joi from 'joi';
+const Joi = require('joi');
 
 // require and configure dotenv, will load vars in .env in PROCESS.ENV
 require('dotenv').config();
@@ -41,4 +41,4 @@ const config = {
   }
 };
 
-export default config;
+module.exports = config;

config/express.js

@@ -1,18 +1,18 @@
-import express from 'express';
-import logger from 'morgan';
-import bodyParser from 'body-parser';
-import cookieParser from 'cookie-parser';
-import compress from 'compression';
-import methodOverride from 'method-override';
-import cors from 'cors';
-import httpStatus from 'http-status';
-import expressWinston from 'express-winston';
-import expressValidation from 'express-validation';
-import helmet from 'helmet';
-import winstonInstance from './winston';
-import routes from '../server/routes/index.route';
-import config from './config';
-import APIError from '../server/helpers/APIError';
+const express = require('express');
+const logger = require('morgan');
+const bodyParser = require('body-parser');
+const cookieParser = require('cookie-parser');
+const compress = require('compression');
+const methodOverride = require('method-override');
+const cors = require('cors');
+const httpStatus = require('http-status');
+const expressWinston = require('express-winston');
+const expressValidation = require('express-validation');
+const helmet = require('helmet');
+const winstonInstance = require('./winston');
+const routes = require('../index.route');
+const config = require('./config');
+const APIError = require('../server/helpers/APIError');
 
 const app = express();
 
@@ -84,4 +84,4 @@ app.use((err, req, res, next) => // eslint-disable-line no-unused-vars
   })
 );
 
-export default app;
+module.exports = app;

config/param-validation.js

@@ -1,6 +1,6 @@
-import Joi from 'joi';
+const Joi = require('joi');
 
-export default {
+module.exports = {
   // POST /api/users
   createUser: {
     body: {

config/winston.js

@@ -1,4 +1,4 @@
-import winston from 'winston';
+const winston = require('winston');
 
 const logger = new (winston.Logger)({
   transports: [
@@ -9,4 +9,4 @@ const logger = new (winston.Logger)({
   ]
 });
 
-export default logger;
+module.exports = logger;

docker-compose.yml

@@ -33,6 +33,6 @@ services:
     links:
       - mongo
   mongo:
-    image: "mongo:3.4.2"
+    image: "mongo:3.4"
     ports:
       - "27017:27017"

gulpfile.babel.js

@@ -1,9 +1,9 @@
-import mongoose from 'mongoose';
-import util from 'util';
+const mongoose = require('mongoose');
+const util = require('util');
 
 // config should be imported before importing any other file
-import config from './config/config';
-import app from './config/express';
+const config = require('./config/config');
+const app = require('./config/express');
 
 const debug = require('debug')('express-mongoose-es6-rest-api:index');
 
@@ -21,7 +21,7 @@ mongoose.connection.on('error', () => {
 });
 
 // print mongoose logs in dev env
-if (config.MONGOOSE_DEBUG) {
+if (config.mongooseDebug) {
   mongoose.set('debug', (collectionName, method, query, doc) => {
     debug(`${collectionName}.${method}`, util.inspect(query, false, 20), doc);
   });
@@ -36,4 +36,4 @@ if (!module.parent) {
   });
 }
 
-export default app;
+module.exports = app;

index.js

@@ -1,9 +1,11 @@
-import express from 'express';
-import userRoutes from './user.route';
-import authRoutes from './auth.route';
+const express = require('express');
+const userRoutes = require('./server/user/user.route');
+const authRoutes = require('./server/auth/auth.route');
 
 const router = express.Router(); // eslint-disable-line new-cap
 
+// TODO: use glob to match *.route files
+
 /** GET /health-check - Check service health */
 router.get('/health-check', (req, res) =>
   res.send('OK')
@@ -15,4 +17,4 @@ router.use('/users', userRoutes);
 // mount auth routes at /auth
 router.use('/auth', authRoutes);
 
-export default router;
+module.exports = router;