Bolster
Please note: This document is currently in DRAFT status and requires further work
Do you yearn to create Backbone Marionette applications that have Backbone Relational & Backbone Radio integration, access to a host of useful helper functions including logging, and can be created from just a few lines of code? Well Bolster is the library for you!
Bolster helps to manage the following tasks in creating and running robust Backbone Marionette applications:
- Initialise and extend core Backbone Relational entities and model scope
- Create the desired Backbone Radio channels
- Initialise and extend core Backbone Marionette entities to include logging, radio event listeners and more
- Create a Backbone Marionette application with specified Modules and entry-point Regions
- Manage the process of starting and stopping Modules per route
Installation
Install using npm:
$ npm install bolster
Documentation
Getting Started
Import the library:
var Br = ;
Define your Backbone Radio channels:
var channels = 'user';
Initialize Bolster:
Br;
Define your Backbone Relational Models and Collections Scope (more on the specifics of Models & Collections later):
var scope = // Models User: Purchase: // Collections Users: Purchases: ;
Add your Backbone Relational Models and Collections to the Backbone Relational Model Scope:
Br;
Create your application config (more on the specifics of Regions & Modules later):
var config = resetWindowOnRoute: true // Always scroll to the top of the page on-route // Application Regions regions: header : '*[data-region="index.header"]' // <div data-region="index.header"></div> in your HTML main : '*[data-region="index.main"]' // <div data-region="index.main"></div> in your HTML footer : '*[data-region="index.footer"]' // <div data-region="index.footer"></div> in your HTML // Application Modules modules: 'Bootstrap' : 'Analytics' : 'Alerts' : 'Search' : 'Help' : 'PlayerControls' : // Traffic Control - which Modules to start and which not to stop on-route traffic: always_on: 'Bootstrap' 'Analytics' 'Alerts' dont_stop: 'PlayerControls' ;
Create your application:
var app = Br;
HTML
@todo
Regions
@todo
Modules
@todo
Backbone Relational
@todo
API
@todo
Companies
The following companies are using Bolster
<a href="http://www.abc.net.au/radio" target="_blank")>Australian Broadcasting Corporation - Radio