Skip to content

Project Ideas and Timeline

Jump to bottom
Saksham Saxena edited this page Jun 13, 2016 · 5 revisions

High Seas API

This is an ideas page for our API which shall be based on Sails.js framework. Those who are completely new to node.js, they may read Get Started Guide on the Sails website.

Because there are many concepts involved in creating a sustainable API, it would be nice to actually grasp those first, and then begin writing the code, which would really take minimal time. Feel free to add relevant links to this article. These would include :

  1. MVC architecture
  2. Why build an API instead of a complete product which includes everything from frontend to backend?
  3. Restricting access to API using some sort of authentication for certain tasks, and keeping it open for the rest
  4. ORMs to translate between your objects in code and the relational representation of the data.
  5. Middleware (this is what we effectively code mostly, and would become obvious after reading on above topics)

Following is a proposed timeline :

  • Week 1
    • Forking this project and cloning it locally
    • Installing node.js
    • Becoming more familiar with git operations
    • Reading more about Objects in JavaScript
  • Week 2
    • Setting up a database (MySQL? Redis? Mongo?)
    • Chalk out some sort of schema for the same.
    • Division of work.
      • Policies/Authentication
      • Writing controllers (server side logic)
      • Writing models
      • Writing responses and services (Will we need them?)
  • Week 3
    • Doubt clearing and getting up to speed
  • Week 4
    • Coding begins
Clone this wiki locally