Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 688 Bytes

README.md

File metadata and controls

35 lines (27 loc) · 688 Bytes

food-API

Requirement

  • postgre
  • redis
  • node v5

Setup

  1. setting up config file, config/local.js, you can copy the template.
$ cp local-development-template.js local.js
$ vim local.js
  1. create postgre database first, then run the initial script
$ createdb food                 # create the postgre db
$ node scripts/init_pg_tool.js  # initial tables
  1. run server
$ npm run dev  # start nodemon

Document

We use apidoc to auto-gen documents, so you need to install it first.

~$ npm install -g apidoc # install apidoc
~$ npm run doc           # generate doc
~$ cd doc && npm start   # startup doc server at port 3020