| 1 | # Lumbar #
|
| 2 |
|
| 3 | [](http://travis-ci.org/walmartlabs/lumbar)
|
| 4 |
|
| 5 | Lumbar is a js-build tool that takes a _general codebase_ and list of _platforms_ to generate modular _platform specific applications_.
|
| 6 |
|
| 7 | ## Quick Start
|
| 8 |
|
| 9 | npm install -g lumbar
|
| 10 |
|
| 11 | See [thorax-seed](https://github.com/walmartlabs/thorax-seed) for an example project.
|
| 12 |
|
| 13 | ## Grunt Plugin
|
| 14 |
|
| 15 | var port = 8000,
|
| 16 | publicDir = './public',
|
| 17 | lumbarFile = './lumbar.json';
|
| 18 |
|
| 19 | grunt.loadNpmTasks('lumbar');
|
| 20 |
|
| 21 | grunt.initConfig({
|
| 22 | server: {
|
| 23 | base: publicDir,
|
| 24 | port: port
|
| 25 | },
|
| 26 | lumbar: {
|
| 27 | // performs an initial build so when tests
|
| 28 | // and initial open are run, code is built
|
| 29 | build: {
|
| 30 | build: lumbarFile,
|
| 31 | output: publicDir
|
| 32 | },
|
| 33 | // a long running process that will watch
|
| 34 | // for updates, to include another long
|
| 35 | // running task such as "watch", set
|
| 36 | // background: true
|
| 37 | watch: {
|
| 38 | background: false,
|
| 39 | watch: lumbarFile,
|
| 40 | output: publicDir
|
| 41 | }
|
| 42 | }
|
| 43 | });
|
| 44 |
|
| 45 | grunt.registerTask('default', 'lumbar:build server lumbar:watch');
|
| 46 |
|
| 47 |
|
| 48 | ## History
|
| 49 |
|
| 50 | See [release-notes](release-notes.md) for release history.
|