This is a project designed to give a backend developer quick access to an easily scalable API in node.js using Hapi. It also provides the user with many tools that are great for development and keeping code streamlined. Some of the features in this are personal preference, but all can be removed or re-imlemented with great ease.
git clone https://github.com/samrocksc/happy-hapi
npm run server
- Open browser to localhost:3001/documentation.
What You Will Get:
- A Cors enabled Hapi Server
- A routes folder with example routes
- Hapi-swagger API Documentation
- An .eslintrc that is very friendly to es6 available in Node LTS.
- Simple database setup with lowdb.
The workflow for this project is very simple, and it can be added to any frontend quickly.
config.js -> index.js -> routes/index.js -> route/ -> handlers/
Usage with Create-React-App
If you're going to be developing using create-react-app, just use a
proxy: "proxy": "http://localhost:3001/", in your package.json.
config.js- contains general server information and swagger data.
server.js- Contains the basics of your Hapi rig, you can modify this to your own data. It comes with hapi-auth-cookie ready to go, you don't have to enable it if you don't want.
server/routes/index.js- Basic route folder. I like to use the array concatenation while developing so I can create my handlers and routes first and then include them in routes to plug them into the workflow.
server/routes/- The entire folder has routes in them that have examples of how Joi works. All of these route files import their handlers.
/server/handlers- Handlers are what the routes deliver their input to. They will take the data and do whatever you need to do with it, three BREAD classes come configured with the default install.