my-hapi-framework v1.4.3

my-hapi-framework

A super simple hapi "microframework".

Features

• Sequelize Support (Sync, Force Sync, Hapi-compliant Logging)
• Autoload Hapi Authentication Strategies
• Autoload Hapi Plugins
• Autoload Hapi Routes
• Database Seed Mode (Promise or Node-style)
• REPL/Console Mode

Supported Databases

• Sequelize

All options into the constructor are in fact optional.

Configuration is passed into the module function as a single object.

All options are indeed optional. Pass in nothing in order to use sensible defaults.

The module function returns a bluebird promise that resolves with the hapi server.

Example

In the example below, we have a folder tree that looks as such:

src
├── auth
│   └── bearer.js
├── models
│   ├── index.js
│   └── users.js
├── plugins
│   ├── auth-bearer-simple.js
│   ├── good.js
│   └── lout.js
└── routes
│   ├── authorize.js
│   ├── facebook-connect.js
│   ├── session.js
│   └── users.js
└── server.js

This is a good server.js for loading such a convention.

Alternative conventions can be established by passing in more options.

For more information, look at index.js and search for everywhere you see config

module.exports = require('my-hapi-framework')({
  start: require.main === module, // so that you can unit test the server easily
  path: require('path').join(__dirname, 'src'), // to store your files outside the project root
  db: { // in this case we will use a database
    sequelize: require('./src/models').sequelize, // provide the sequelize instance
    sync: { // existence of this key means we should sync the database
      force: process.env.FORCE_SYNC // force sync will be controlled by env var
    }
  }
})

Advanced Example

In this example, we enable the repl and database seeding capablities

module.exports = require('my-hapi-framework')({
  start: require.main === module,
  path: require('path').join(__dirname, 'src'),
  repl: process.argv[2] === 'console',
  db: {
    sequelize: require('./src/models').sequelize,
    sync: { force: process.env.FORCE_SYNC },
    seed: [process.argv[2] === 'seed', function(db, nodeStyleCallback) {
      return db.models.User.createWithPassword('pass', {
        email: 'admin@example.com',
        roles: [ 'admin' ]
      });
    }]
  }
})