Express server boilerplate, with babel for ES6 features, basic authentication with JWT, MongoDB as a database

1. NodeJS
2. MongoDB Server

0. install dependencies npm install

1. build and run for production: npm run build && node ./dist/app.js

2. run in dev mode: npm start

3. generate data for development and testing npm run populatedb , to remove the generated data : npm run cleandb or an alias to do both npm run cleanpopulate

A combined alias of the two previous commands npm run cleanpopulate

This is the main server configuration containing:

{
  serverConfig: {
    host: 'localhost',
    port: 8080,
    useHttps: false // optional
  },
  dbConfig: { 
    host: 'localhost',
    dbName : 'brandt-db'

    /** optional params **/
    username:'johndoe',
    password:'pass123',
    port: 27017,
    hosts:[ 'host0:port0', 'host1', 'johndoe:pass123@host3' ]
    // more to come dbOptions for replica sets etc...
  },
  jwtSecret: '<app-jwt-secret>', // used for signing and verifying JWTs
  bcryptSaltWorkFactor: 10, // Password Hashing Factor
  morganLogMode: 'dev', // can be 'dev' or 'combined' for apache style or any morgan format
}

Note: In production an external json config file can be used to override the above settings

node dist/app.js --configFile /home/user/.configs/server.json

Request:

> POST /auth/token { username:"user123", password:"12345" }
< 200 {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyVHlwZSI6ImFjY291bnQiLCJkYXRhI....."
}

List Users [ requires permission : users:read ]

> GET /users

Create User [ requires permission : users:write ]

> POST /users { 
    username: "johndoe", 
    password: "abc12345!", 
    permissions: "res0:read res0:write res1:read" // optional
}

Edit user by username [ requires permission : users:write ]

Note : username and password fields are not editable.

> PUT /users/:username {
    permissions: "res4:read"
}

Delete user by username [ requires permission : users:write ]

Note : username and confirmUsername should be identical as a validation measure

> DELETE /users {
    username: 'johndoe',
    confirmUsername: 'johndoe'
}

All errors produced by the server are of the following format:

RESPONSE (status=404) {
    "error": {
        "code": "00000",
        "message": "404 Not Found"
    }
}

HTTP Status Code : provides error information about the transport layer.

Error Code : 5 digit String serving as an identifier for App Layer errors, defaulting to a "00000" in case of unhandled errors.

1. 00000 : Unknown or unhandled errors

2. 01XXX : Authentication

Message : a String description of the error.

The project is using Mocha testing framework, and Chai assertion library. The test files are under the tests/ directory, and are devided onto two categories tests/integration/ and tests/units/ respectively for integration and and unit tests.

Run Integration Tests :

> npm run integration-tests

Run Unit Tests :

> npm run unit-tests

Run Unit Tests in watch mode:

> npm run unit-tests --watch