ospoon-merchant v1.0.0

Orderspoon Merchant

This project is a merchant app and server using NodeJS. The primary user is a merchant or manager of a restaurant.

Requirements:

The following documents describe what this app should do. Keep in mind there is a consumer-facing app (ospoon-web), a merchant-facing web app (ospoon-merchant), merchant-facing Android app that runs on the Clover device (ospoon-merchantalert).

• Overall Technical Specs
  • Webhook Example Events
• Feature Set Summary

How to Get Started:

One command for setting up this project

npm install && npm install -g nodemon

It's nice if you can use watcher to develop such as nodemon.

To run server:

npm run server

Project structures:

/app

Front end application. Please read README files inside it.

/config

Server config file inside here. This config folder file loaded using popular npm package Config. Read the documentation for more details.

/libs

3rd party libraries that cannot be installed using NPM or our own library should be put in here.

/models

All model files should be put in here.

/modules

Project module here. Each module consists of 4 files:

• index.js --> module router (HapiJS route)
• *-controller.js --> module controller
• *-model.js --> module model
• *-validator.js --> router validator (HapiJS route validation)

/plugins

You can put your own HapiJS plugin or 3rd party plugins and require it in index.js

/templates

Put your template files inside here. There is template modules inside it that can help you to create new module quickly by copy the template module folder into /modules and rename it as needed.

/utils

You can put your utility file here, eg: db connection, logger, etc.