Architecture Design For A Web Application

First of all, hope you familiar with the term SOA and read this book, or knowledge gap will prevent you from completing this job.

Architecture Design for a web application

Objective

Architecture design will break down the app into small isolated functions that can be completed by junior developer just based on this architecture design doc alone.

Structure

Back-end only use RESTful API to send JSON data to front-end, and front-end only use RESTful API to save data to back-end. JSON data fetched is rendered through backbone.js.

Audience

Junior developers who have experience in:

  1. LAMP stack

  2. Yii Framework

  3. Backbone.js

  4. Jquery

Content

  1. RESTful API to Fulfill Business Requirement

DESCRIPTION, URL STRUCTURE, VERSIONS, METHOD, PARAMETERS, RETURNS

  1. DB Structure
  • Explanation for each segment in each table

  • How key fields work

  • Table Definition to be imported to MySQL

  1. Program Structure & Logic in key process, API usage, e.g.
  • Send invoice

  • Pay invoice

  • Approval

  • Payment

  • Authentication & authorization

  • 3 Plans, roles, UI for different users

  • Plan Upgrades

  • Alert, message

  1. Example in Yii, backbone

Several examples on how back-end & front-end work together, e.g using backbone to display invoice data fetched through RESTful API in JSON format.

  1. Testing plan

This job requires experience in SOA + RESTful API design. The deliverable is a design doc ready to be handed to developer.

Contact nicolas@vitaspider.com

Thank you!