| 1 | Dust [](http://travis-ci.org/linkedin/dustjs)
|
| 2 | ====
|
| 3 | This is the LinkedIn fork of Dust.
|
| 4 |
|
| 5 | ## Getting Started
|
| 6 | A quick tutorial for how to use Dust <https://github.com/linkedin/dustjs/wiki/Dust-Tutorial>
|
| 7 |
|
| 8 | More info <http://linkedin.github.io/dustjs/> and <http://linkedin.github.io/dustjs/#installation>
|
| 9 |
|
| 10 |
|
| 11 | ## More
|
| 12 | Read more here: <http://linkedin.github.com/dustjs/>.
|
| 13 |
|
| 14 | For LinkedIn dust-helpers: <https://github.com/linkedin/dustjs-helpers>.
|
| 15 |
|
| 16 | For LinkedIn secure-filters : <https://github.com/linkedin/dustjs-filters-secure>.
|
| 17 |
|
| 18 |
|
| 19 | ## Building Dust locally
|
| 20 | ### Grab a copy of the repo
|
| 21 | ```
|
| 22 | cd some_project_directory
|
| 23 | git clone https://github.com/linkedin/dustjs.git dustjs
|
| 24 | cd dustjs
|
| 25 |
|
| 26 | ```
|
| 27 |
|
| 28 | ### (Optional) Install Grunt-cli
|
| 29 | * Grunt-cli lets you run Grunt from within a subfolder see http://gruntjs.com/getting-started
|
| 30 | ```
|
| 31 | npm install -g grunt-cli
|
| 32 | ```
|
| 33 |
|
| 34 | ### Fetch all node dependencies
|
| 35 | ```
|
| 36 | npm install
|
| 37 | ```
|
| 38 | ### Run tests
|
| 39 | ```
|
| 40 | grunt test
|
| 41 | ```
|
| 42 |
|
| 43 | ## Contributing to Dust
|
| 44 |
|
| 45 | * Setup a branch for what you are working on
|
| 46 |
|
| 47 | git checkout -b myBranchName
|
| 48 |
|
| 49 | * Test your changes (jshint, unit tests in node, rhino and phantom and make sure test coverage thresholds are met)
|
| 50 |
|
| 51 | grunt test
|
| 52 |
|
| 53 | * Use `grunt dev` while developing\debugging.
|
| 54 | This task will start a server and serve Jasmine spec runner on http://localhost:3000/_SpecRunner.html.
|
| 55 | This task uses unminified dust-full.js so it allows you to easily step through the code in a browser.
|
| 56 |
|
| 57 | * Use `grunt testClient` to test production version of code (dust-full.min.js) in a browser.
|
| 58 | Similarly to `grunt dev` it serves Jasmine spec runner on `http://localhost:3000/_SpecRunner.html`.
|
| 59 |
|
| 60 | * Add unit tests. Unit tests can be found in the `test/jasmine-tests/spec` directory. Help us keep up good test coverage! To view coverage report run `grunt coverage` and open `tmp/coverage/index.html` in a browser.
|
| 61 |
|
| 62 | * Add an issue and send a pull request. Pull requests are easier to track if you also include an issue. Sending a pull request from a branch makes it easier for you to resolve conflicts in master
|