Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (41 loc) · 1001 Bytes

README.md

File metadata and controls

60 lines (41 loc) · 1001 Bytes

happijs

Happi-based Web API Framework

Installation

After nodejs installed:

# Get the latest stable release of Happi
$ npm install happi -g

Your First Happi Project

Create a new app:

# Create the app
$ happi new testProject

Run the app:

# cd into the new folder
$ cd testProject

# fire up the server
$ happi run

Generate a REST API:

# Generate new api
$ hapi generate api user

# Result
# ./api/models/User.js
# ./api/controllers/UserController.js
# ./api/services/UserService.js

# Generate individual components
$ happi generate [controller, model, service, apdapter, policy, response, config] << component name >>

# [[** Project structure **]]
# ./api/models
# ./api/controllers
# ./api/services
# ./api/policies
# ./api/responses
# ./api/config

Compatibility

Happi is built on Node.js v6.x, Express v4.x, and Socket.io v1.x.