@horwood/server v1.0.17

@horwood/server

This is a simple Node.js module that allows the user to quickly bootstrap a server utilising the Express framework.

Getting Started

It is available through the NPM registry by using the following command:

$ npm install @horwood/server

Running via the CLI

In order to run the server from the CLI, run:

$ horwood-server

The server must be provided with a server.conf module in order to function. By default, it looks in the root directory of your project for a module named server.conf. If you wish to override this, you can use the following command:

$ horwood-server --server-conf=./path/to/server.conf

Running Programmatically

To run the server programmatically, you must call Server.start using a valid ServerConf.

const horwoodServer = require('@horwood/server');
const serverConf = new horwoodServer.ServerConf(require('./server.conf'));
horwoodServer.Server.start(serverConf);

Configuration

Configuration should be provided using the following format:

const port = 8080;
const serverConf = {
  'logConf': {
    'location': './logs',
    'preserve': false,
    'level': 'INFO'
  },
  'endpoints': [
    {
      'method': 'GET',
      'path': '/',
      'callback': (req, res) => {
        res.json(serverConf.endpoints)
      }
    }
  ],
  'port': port,
  'prefix': '/api',
  'staticConf': {
      'prefix': '',
      'root': 'dist'
  },
  'proxies': [
      {
          'path': 'endpoints',
          'destination': `http://localhost:${port}/api`
      }
  ],
  'sockets': true,
  'socketsCallback': (io) => {
      io.on('connection', (socket) => {
         socket.emit('testEvent'); 
      });
  }
};
module.exports = serverConf;

Valid configuration properties are listed below.