slush-hapijs

Slush generator to scaffold out HapiJS APIs. Includes JWT authentication and Swagger docs built in

Getting Started

Welcome to the HapiJS REST API generator for Slush. Slush-hapijs will scaffold out a HapiJS API server.

Prerequisites

As with any Slush generator, you will need to have Node and Slush installed globally.

Install slush globally:

$ npm install -g slush

After you have all the prerequisites installed, install the Slush-hapijs generator globally.

Install slush-hapijs globally:

$ npm install -g slush-hapijs

Usage

Create a new folder for your project:

$ mkdir my-project

Run the generator from within the new folder:

$ cd my-project 
$ slush hapijs
$ npm install

There are some basic scaffolding questions to help get your application built out. During the scaffolding process.

Sub-Generators

Route

To install a route, navigate to the directory you want to create the route in. For example, if you want to add a route to your API routes directory, navigate to the root of that folder. Then run:

$ slush hapijs:route

Answer the questions to setup your route.

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2017, Brian Schneider

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.