https://github.com/coolshare/newframework-architect

https://github.com/coolshare/newframework-architect

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/coolshare/newframework-architect
• Owner: coolshare
• Created: 2018-08-25T20:54:05.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-01T18:37:49.000Z (over 7 years ago)
• Last Synced: 2025-04-11T17:52:40.275Z (about 1 year ago)
• Size: 305 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
New Framework: Architecture

=================================

By Mark Qian 8/2018 (markqian@hotmail.com)

A. Introduction:


About a years ago, I, as the UI lead/architect, started an UI of SDN (Software-defined networking) project from scrach. The requirements including the following:




  
highly componentized: there is a protential to eventually deliver a platform where third-party coders can share the components used by company's primary UI

  
rapidly changable: in many cases, PM want to sit with UI to apply design (modification or creation on the fly while discussing.

  
model driven: server side will generate/deliver (even runtime) a list of "models" and UI should be able to  render them

  
other "regular" requirments: highly dynamically (heavily streaming), highly graphicall (a variety of charts and operatable diagrams) and so on






B. Result:
 

Currently, as a result, a framework has been established and several applications are built on the framework. The framework provides the following:




  


highly componentized: any application, as a container, built on the framework contains two types of highly decoupled "objects": UI component (boxes in light blue below) and services (circles in orange). Pub/Sub is used for communication:

  

  As you can see in the diagram above, no object reference to others: for example, an UI component has no idea about whom its request (publish) is served by and a service also has no idea about where the request is coming and where the response from server is return to: "objects" in the container is hightly isolated!

  


rapidly changable: we only need about 5 minutes to put together a regular form or table and it takes only seconds to add/remove/modify a field since we only need to edit the UI schema and the rest will be taken care by the framework. You will see how in the "Schema Driven" section

  


model driven: the framework can render any "regular" models out of model definition delivered by server. The rest of screens need some special "UI muscle". The percentage depends on application.

  


One major character of this framework is that any application built on it contains no application logic (work flow) until the runtime - the application logic is loaded from a json configuration file at runtime. That is, the logic is extracted out of codes as data. The details are available in the "Schema Driven: UI Handling Application Logic" section

  


Communication pattern is another key design point in this framework


    Pub/Sub plays many roles in this architecture: isolate views and services, link and field/view (in schem or in js code) to topics.

    See details at Schema Driven: Each field handle special interaction

  

  



C. Details on Design and Implementation:




  
1. Problem:

  
2. Solution:



(Under construction)