https://github.com/knpwrs/amdust-build-example

An example of using r.js to build and optimize an application utilizing AMDust.
https://github.com/knpwrs/amdust-build-example

Last synced: 1 day ago
JSON representation

An example of using r.js to build and optimize an application utilizing AMDust.

• Host: GitHub
• URL: https://github.com/knpwrs/amdust-build-example
• Owner: knpwrs
• License: mit
• Created: 2012-10-28T03:37:57.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-06-22T02:20:21.000Z (over 11 years ago)
• Last Synced: 2024-06-11T17:37:40.759Z (5 months ago)
• Language: JavaScript
• Size: 145 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#AMDust Build Example

##Overview

This is an example of a simple application using [`AMDust`](https://github.com/KenPowers/AMDust) and [`RequireJS`](http://requirejs.com). The primary purpose of this example project is to demonstrate how to use `RequireJS`'s [`r.js`](https://github.com/jrburke/r.js/) to build and optimize a project with [`dust`](http://akdubya.github.com/dustjs/) templates. While optimizing the templates will be compiled and automatically inserted into the final built script. What this means is that during development the compiler code will be downloaded to the client and the templates will be compiled client side, but after optimization no compiler code is downloaded and the templates are already compiled for the client to use.

##How To

First, install [`RequireJS`](http://requirejs.com):

    npm install -g requirejs

Next run the optimizer:

    r.js -o app.build.js

The optimized application will now be available in the `target` directory. You can try out the application by serving the `target` directory using one of the following two recommended methods:

Using [`nws`](https://github.com/KenPowers/nws):

    nws -d target

Using Python:

    cd target

    python -m SimpleHTTPServer

##About the `app.build.js` File

The main value to pay attention to is the `stubModules: ['dustc']`. What this means is that the code which compiles templates will not be included in the build, significantly reducing the download size. `dustc` includes code which will output the compiled templates into the final build.

##License

**The MIT License**

Copyright (c) 2012 Kenneth Powers 

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.