Implement the basic features based on the initial data structures

[mhaidarhanif]

• Kind: Statement of Work
• Title: Implement the initial data structures
• Author: M Haidar Hanif
• Affiliation: Michi
• Date: 2016-03-19
• Version: 0.1

  SOW

  Overview

Implement the basic features based on the initial data structures. Should prove the data process are working correctly in the app.

Tasks

Username

• [x] Implement username assignment ability for a new visitor.
• [x] The visitor is able to have a username as the questioner.
• [x] Usernames that already set by Users are stored.

  Post a question

• [x] Implement question posting feature.
• [x] The questioner is able to post a question/thread.
• [x] Questions that already posted by Users are stored and listed.

  Answer a question

• [x] Implement question-answering feature.
• [x] The other visitor who has a username is able to answer/comment a question/thread.
• [x] Answers that already be given by Users are stored and listed below the Answers.

  Deliverables

With GET method via REST API, we can:

• READ: Visitor and User are able to see their username, list of questions, and its answers.

With PUT method, we can:

• CREATE: Visitor is able to have a username (become a User), post a question, and answer a question.

With POST method, we can:

• UPDATE: User is able to update their question or answer.

With DELETE method:

• DELETE: User is able to delete their question or answer.

  Dependencies

Understand the basic features (https://github.com/gunadarma-academy/asde-michi/issues/9) and the initial data structures (https://github.com/gunadarma-academy/asde-michi/issues/10).

Assumptions

This basically make the app functionally correct.

[mhaidarhanif]

Hapi Boilerplates:

• http://hapijs.com
• https://github.com/glennjones/hapi-swagger
• https://github.com/dave-irvine/node-hapi-raml
• https://github.com/p-meier/hapi-rest-mongo
• https://github.com/agendor/sample-hapi-rest-api
• https://github.com/rcorral/hapi-restful-api-example
• https://github.com/raquo/minimal-hapi-react-webpack
• https://github.com/aduis/generator-hapi-rest-api
• https://github.com/tafarij/slush-hapi-react

Vue boilerplates:

• http://vuejs.org
• https://github.com/rodzzlessa24/vue-webgulp
• https://github.com/layer7be/gulp-vuemaker

[mhaidarhanif]

References:

• http://hapijs.com/tutorials/auth
• https://phraseapp.com/blog/posts/best-practice-10-design-tips-for-apis
• http://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api
• http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

[mhaidarhanif]

One of the actual application implementation is running at http://arlin.link But this SOW is still not considered as done. Because it's not using REST API yet.

[mhaidarhanif]

Correction: Consider this as done. It's already functional. But the new version is yet to come. Still WIP at http://dev.arlin.link