by waiterio

GitHub Readme.md

waiterio/api 🌐

Build Status Code Climate CodeCov Dependencies

The api for the frontend of the waiter service build with postgres and node. To get started, read the installation instructions below. If would like to request a feature or report a bug, please submit an issue.


There are two ways to get the api up and running. The simplest way is to press this magical 🌈 button that deploys the project to your one of your heroku dynos.


If you'd rather get your hands dirty and do it yourself, you first of all need to clone this repository. After you have done that, you need to install the required dependencies using npm. During the installation of the required modules you might as well grab a cup of coffee (depending on your internet connection this might take a little longer).

$ npm install

After the dependencies are installed, all that's left is configuring the applications settings to your liking. You can find the settings in the settings.js file in the projects root directory.

	"port": 8081,
	"saltRounds": 10,
	"environment": "development",
	"secret": "SuperSecretWaiterIOStuff",
	"expireDays": 7,
	"database": "waiter.db"

Try it yourself

There's a live demo of this api at: https://waiterio-api.herokuapp.com/