Skip to content

Conceptual Framework

johnenrick edited this page Apr 28, 2017 · 1 revision

Conceptual Framework

The application is divided into two parts, Back End: Laravel 5 and Front End: vue-webpack. This two parts can communicate through AJAX and uses API Structure.

Diagram

Back End

Back End only handles API requests. It is built using Laravel 5 framework and follows the MVC model where view is a JSON encoded response

API Route

API route handles the routing of all API requests and add an additional security layer with token based authentication using jwt-auth. The request must pass the Access Control Filter to proceed to the API Controller

Database

Database operations can only be handled with Eloquent API Model

Front End

Front End serves the documents to the client. It uses vue-webpack boilerplate.

Helper

Helpers are functions that has specific functions that can be called anywhere in the component or module. It is dependent with its caller and cannot run in the background

API Helper

API helper is a helper that handles all the api requests. It is used instead of using native or jQuery AJAX.

Services

Services are functions that can run without being called by a component or module. It can also run in the background.

Modules

Module is a group of functionality and components. It is the content in every pages. It can call services and helpers

Components

Components is a component that can be used by different modules. It act as a plug in or widget. Just like module, it can also use services and helpers

Note: Italized component refers to the vue component

Clone this wiki locally