Notoriously Psychedelic Modules

    @fabrix/spool-hapi
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.1 • Public • Published

    spool-hapi

    Gitter NPM version Build Status Test Coverage Dependency Status Follow @FabrixApp on Twitter

    Hapi spool. This pack binds the routes compiled in spool-router to a Hapi Server.

    Install

    $ npm install @fabrix/spool-hapi --save

    Usage

    Load in your spool config.

    // config/main.js
    export const main = {
      // ...
      spools: [
        require('@fabrix/spool-router').RouterSpool,
        require('@fabix/spool-hapi').HapiSpool
      ]
    }

    View Config

    Choose a template engine.

    // config/views.js
    export const views = {
      engine: 'handlebars'
    }

    Then simply write your views in a directory called 'templates'! This feature has been tested with Jade and Handlebars.

    Configuration

    See config/web.js for an example.

    port

    The port to listen on. 3000 by default. Can also be set via the PORT environment variable.

    Server configuration

    Configure your Hapi.Server by adding options property to the web.js config in typical Hapi.server format. See: http://hapijs.com/api#new-serveroptions

     
    // config/web.js
    module.exports = {
      options: {
        routes: {
          cors: true
        }
      }
    }

    Hapi Plugins

    Register your hapi plugins by adding them to the config/web.js config in typical Hapi plugin format. See: http://hapijs.com/tutorials/plugins#loading-a-plugin

    // config/web.js
    module.exports = {
      plugins: [
        {
          plugin: require('vision'),
          options: { }
        },
        {
          plugin: require('inert'),
          options: { }
        },
        {
          plugin: require('hapi-auth-hawk'),
          options: { }
        }
        // ...
      ],
     
      onPluginsLoaded: function (err) {
        // Note that `this` is fabrix `app` instance
        this.spools.hapi.server.auth.strategy('default', 'hawk', { getCredentialsFunc: getCredentials });
      }
    }

    Hapi Views

    // config/web.js
    module.exports = {
      views: {
        engines: {
          html: require('some-view-engine')
        },
        path: 'views'
      }
    }

    Static Assets

    // config/main.js
    module.exports = {
      paths: {
        ...
        www: path.resolve(__dirname, '..', 'static')
        ...
      }
    }

    This allows static files such as js or images to be served in the /static directory. If you prefer, feel free to use a name other than 'static'!

    Multiple Static Assets

    // config/main.js
    module.exports = {
      paths: {
        ...
        www: [
          {
            path: path.resolve(__dirname, '..', 'static'),
            humanUrl: '/admin'
          },
          {
            path: path.resolve(__dirname, '..', 'uploads', 'pictures', 'cats'),
            humanUrl: '/cats'
          }
        ]
        ...
      }
    }

    Also you can make multiple static assets with human url. For example your static files in /uploads/pictures/cats with humanUrl you url look like http://example.com/cats humanUrl - not require

    Contributing

    We love contributions! Please check out our Contributor's Guide for more information on how our projects are organized and how to get started.

    License

    MIT

    Install

    npm i @fabrix/spool-hapi

    Homepage

    fabrix.app

    DownloadsWeekly Downloads

    23

    Version

    1.6.1

    License

    MIT

    Unpacked Size

    34.9 kB

    Total Files

    43

    Last publish

    Collaborators

    • scottbwyatt