#MontageJS Readme MontageJS is a new type of application framework powered by standard web technologies. Designed with an eye toward maintainability and performance, MontageJS simplifies the development of rich HTML5 applications by providing modular components, real-time two-way data binding, object serialization with DOM mapping, event handling, a managed component draw cycle, CommonJS dependency management, and many more conveniences to help build robust single-page web applications.
Note: MontageJS is still in alpha.
##Declarative Data Binding MontageJS makes it easier to manage your application and UI state with data bindings. A UI component or MontageJS object can establish a simple or bi-directional binding with another component or object. When the bound property, or deeper property path, of the bound object is updated then the source object is kept in sync.
MontageJS uses functional reactive bindings (FRB). Unlike “traditional” bindings, FRB can gracefully bind long property paths and the contents of collections. They can also incrementally update the results of chains of queries including maps, flattened arrays, sums, and averages as well as add and remove elements from sets based on the changes to a flag. FRB makes it easy to incrementally ensure consistent state. FRB is built from a combination of powerful functional and generic building blocks, making it reliable, easy to extend, and easy to maintain.
For more information, see FRB.
##CommonJS MontageJS fully supports CommonJS modules and is a part of the Node and NPM package ecosystem.
For more information, see CommonJS.
#Requirements To get started with MontageJS, you will need the following:
- Node.js and npm. MontageJS application development depends on npm, the Node package manager, which is distributed with Node.js.
- A recent stable release of Chrome, Safari or Firefox. MontageJS is intended to leverage the evolving web platform of modern browsers.
- To contribute: A Git client and public SSH key. For details on installing Git and creating your key, see the setup guides on github.com.
#Quick Setup To start using MontageJS, follow these steps:
Download and run the prebuilt Node.js installer for your platform from the Node.js website.
minit, the MontageJS Initializer.
minitis a command line utility that will help kickstart your MontageJS project by generating prebuilt MontageJS application templates and components and placing the associated files inside the proper directories of your project.
Mac OS X / Linux
$ mkdir -p ~/.npm $ sudo npm install -gq minit@latest
Run the "Node.js command prompt"
$ npm install -gq minit@latest
minitto create your MontageJS project:
$ minit create:app -n yourappname
Note: If you get an EACCES warning when trying to run
sudo chown -R <username> ~/.npmand then use
$ minit create:app -n hello. This is a workaround due to a bug in npm.
This generates a new directory—yourappname, which contains the default MontageJS application template, including the production dependencies—in your current directory.
To verify your installation, switch to yourappname directory and serve your new MontageJS project using
$ cd yourappname $ minit serve &
Point your browser to http://localhost:8083/.
You should see the contents of the Welcome component—a simple single-page application, which is explicitly loaded to accompany our Quick Start tutorial.
##Where to Go from Here For a quick introduction on how to assemble MontageJS components into a user interface, refer to the section “Say Hello to MontageJS” in our Quick Start tutorial. For more information on MontageJS components, bindings, event handling, serialization etc. refer to the documentation (be patient: we are currently in the process of updating the docs).