iamgeorgelee/kibo

Project Kibo main backend

#kibo

##Getting Start

###Locations

• Production Version Ignore the landing page. Web version will no longer be updated.
• Herokuapp log
• API Doc

###API Call Example http://[Host]/api/[method]

https://kibo.herokuapp.com/api/localLogin

Send with username and password

###Before Build Please remember to lint your code and build documentation. Simply just type this in command line:

grunt

####Grunt Grunt is a multi-tasker, it can do multi tasks in just one command. Tasks are all describe in Gruntfile.js Currently we do:

• jshint - Check styling and basic errors
• yuidoc - Generate documents. Can access from https://HOST/docs

###Before Push

• Use JS Beautifier
• Comment with YUIDoc syntaxs
  • YUIDoc Syntax
  • More explaination about YUIDoc

##TODO

###Higher Priority

• use "$push" to re-write several places(restaurant, preference).
• getFriendList, getFriendCandidate if not found should all return empty array so that return type is consistent
• Apply error handling to all call
• HTTP status code
• User preference only yes or no, not -1, 0, 1
• Able to create user defined event: choose restaurant from recommendation, pick friends, send notification, user receive invite and accept/reject. Voting.
• Error message should return with HTTP status code
• Move facebook App secret to DB
• [bug] Not handling facebook paging
• [bug] All id should use object id?
• API proteced with OAuth 2
  • http://thewayofcode.wordpress.com/2013/11/25/how-to-secure-your-http-api-endpoints-using-facebook-as-oauth-provider/
  • http://coderead.wordpress.com/2012/08/16/securing-node-js-restful-services-with-jwt-tokens/
  • http://www.sitepoint.com/using-json-web-tokens-node-js/
  • https://github.com/hokaccha/node-jwt-simple
  • https://docs.auth0.com/nodejs-tutorial

###Lower Priority

• rewrite authenticate and move passport.js
• local signup - verify password strong or not
• async.series should rewrite with async.waterfall? Some maybe
• Get all restaurant (for search)
• Mocha - Unit Test
  • Grunt Mocha Plugin
  • User Mocha to test your RestAPI
• Security Scan
  • Dynamic Code Analysis(Fuzz in run time), Static Code Analysis(Scan code for security vulnerability)
• Uglify

CheatSheet for writing README.md