bbelhadi/tetra

A clean MVC javascript framework to build faster, more maintainable and better structured apps.

Tetra, a clean MVC javascript framework

Tetra aims to help developers build faster, more maintainable and better structured code.

Tetra is a complete MVC (Model, View, Controller) framework, normalizing all implementations through a simple structure that splits the code into 3 different layers :

• View: DOM access and UX behaviors
• Controller: Programmatic logic
• Model: Structured data and Ajax requests

Each layer has access to a communication pipe linked to a potential listener, allowing asynchronous communication between each part of the application.

The Tetra.js framework is also Object-oriented, encouraging the developer to better separate and organise structured data and its associated logic. An ORM (Object-Relational Mapping) encapsulates Ajax transactions and ensures data consistency between front- and back-end.

Additionnally, the "bootnode" feature allows JavaScript resources to be loaded dynamically, either through data attributes set on DOM nodes or via a dependency management system.

Tetra core tree

• lib
  • conf: Tetra.js configuration files for each platform.
  • deps: External dependencies of the client-side framework.
  • mod: Additonal modules of the framework. Ability to extend native implementation with advanced features. Already implemented modules are:
    • libAbstracted: Abstracted library to use Tetra.js with librairies other than jQuery. Prototype and Node.js connectors are already implemented.
    • require: The RequireJS library, used client- and server-side (Node.js) dependency loading
    • tmpl: Templating system integrated into the controller and view layer in both the client and server environments.
  • tetra-controller.js: Controller layer
  • tetra-model.js: Model layer
  • tetra-view.js: View layer
  • tetra.js: Core of Tetra.js framework, an interface that provides acceess to the MVC layers, framework extensions and debug features.

Configuration files are used to construct the core object needed to build mvc apps. It must have the following structure :

tetra.extend({
	conf: {
		env: 'jQuery',
		jsVersion: 347,
		enableBootnode: true
	}
}).start();

If the default settings are sufficient, you need only call the start function (as in /conf/default.js):

tetra.start();

Applications tree

By default, the Tetra.js framework expects a particular directory tree structure. Following this convention allows you to use the bootnode feature to dynamically load JavaScript resources.

• tetramvc
  • apps
    • application name
      • controller: Controller classes of the application
        • ***.ctrl.js
      • model: Model classes of the application
        • ***.class.js
      • view: View classes of the application
        • ***.ui.js
  • model: Global model classes

Table of content

• View layer
• Controller layer
• Model layer
• ORM: Object-Relational Mapping
• Templating system
• Bootnode
• Debugger

Licence

(The MIT License)

Copyright (c) Viadeo/APVO Corp., Olivier Hory and other Tetra contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.