Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 2.91 KB

.README.md

File metadata and controls

90 lines (65 loc) · 2.91 KB

${pkg.name}

${badge('npm')} ${badge('travis-status')}

${pkg.description}

The plugin is actually only a server.route hapi call, nothing more.

${badge('nodei')}

${badge('dependencies')} ${badge('devDependencies')}

Install

npm install --save ${pkg.name}

Why ?

If you use hapi with glue or rejoice, you may want to declare the routes of your application from the manifest.json:

{
  "server": {
    "port": 8000
  },
  "register": {
    "plugins": [
      "h2o2",
      {
        "plugin": "hapi-routify",
        "options": {
          "routes": [{
            "method": "GET",
            "path": "/{path*}",
            "handler": {
              "proxy": {
                "host": "localhost",
                "port": 3000
              }
            }
          }]
        }
      },
      "blipp"
    ]
  }
}

This example uses h2o2 to proxy all your requests to http://localhost:1337.

If you use rejoice there are actually two ways to provide your own handler:

Options

Dependencies

${dependencies()}

Contribute

Contributions are welcome! Open an issue to report bugs or request features. To contribute with code:

  • clone this repository
  • install the dependencies with npm install
  • make your changes to the files in the src/ folder
  • write tests using lab in the test/ folder
  • run tests with npm test. try to keep test coverage about 100%
  • edit the .README.md file and build the project again (npm run compile)
  • send a pull request against the master branch

Author

${author()}

Inspired by garthk's hapi-restify.js gist.

License

${license()}