mbt

Mobile Build Tool

The tool is a set of libraries and tasks to help you install, configure, build, and maintain your mobile project based on Backbone.js and jQuery Mobile. This project is based on wonderful library called Grunt.

The tool is opinionated. AMD is popular these days but we decided to keep it 'simple' and use $script.js for loading resources in development. During release everything is minified and bundled into one file ready for production.

By default MBT currently includes:

• Underscore.js v1.3.3 we are also reviewing Lo-Dash
• Backbone.js v0.9.2
• jQuery v1.7.2
• jQuery Mobile v1.1.0
• jquerymobile-router v0.9

##Install:

npm install -g mbt

##Generate new js project:

mkdir PROJECT_FOLDER
cd PROJECT_FOLDER
mbt init:project
npm install ./

##Generate new coffee project

For people who prefer CoffeeScript

mkdir PROJECT_FOLDER
cd PROJECT_FOLDER
mbt init:project:coffee
npm install ./

Generated project's folder structure

• assets - compressed css and JavaScript files
• css
• images
• js
• collections - backbone collections
• config - app config, namespace, environments
• helpers - app helpers
• models - backbone models
• vendor - vendor dependecies
• views - backbone views
• app.js - starting point for the app
• files.js - array of paths to app source files
• init.js - loads dependecies and initializes JQM, PhoneGap
• router.js - jQM router
• templates.js - compiled templates from templates folder
• coffee - similar structure to js folder if coffee is your cup of tea...
• templates - project templates compiled into js/templates.js
• views - jQuery Mobile pages appended into body element in index.html
• index.html

##Watch for changes in templates, views and styles:

grunt watch

Templates will be compiled into one JavaScript file called templates.js.

Views will be minified and appended to body element in index.html.

CSS files will be minified and compiled into one file called assets/app.css.

CoffeeScript files will be compiled into corresponding files under js folder.

##Run specs:

grunt jasmine

##Release for PhoneGap

grunt release

Release task lints, minifies and packages all JavaScript files listed in files.js file into one file: assets/app.js.

It prepends cordova.js (the PhoneGap source file) to files list before minifaction. After minifications app.css, app.js and images are copied into phonegap/iphone/www/ and phonegap/android/assets/www folders and are ready for PhoneGap.

TODO

• command line generator for models, collections, views
• better release task to allow for releasing into different envs (dev, test, prod)
• add support for different templating systems

Contributors

##Contributors

• @mkuklis (Michal Kuklis)
• @ahamid (Aaron Hamid)
• @parkr (Parker Moore)

##License:

(The MIT License)

Copyright (c) 2012 Incandescent Software

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.