lufax

Boilerplate Build Buddy.

The tool for modern web application development.

Install with NPM: npm install -g bbb

To test installation, run the bbb command. You should see something like this:

If you wish to contribute or just want to install from source, run the following commands:

# Clone the repository.
git clone git://github.com/backbone-boilerplate/grunt-bbb.git

# Change directory into it.
cd grunt-bbb

# Update all the submodules (including the nested submodules in init).
git submodule update --init --recursive

# Allow bbb to be globally accessible.
sudo npm link

All commands are prefixed with bbb in your terminal. For example the command init below would be executed like this:

bbb init

Multiple commands can be chained together, except for the JamJS commands which take a command line argument.

Tasks are defined inside the grunt-bbb project and also borrowed from other projects, such as: grunt-contrib, grunt-jasmine-task, and grunt-target-html.

If you have problems with borrowed tasks, please file issues on the respective projects.

These commands will build out files for you.

Scaffolds out a bare Boilerplate project.

Creates a new module file in app/modules, creates a respective style file in app/styles, and creates a respective Layout template for the module in app/templates.

Creates a boilerplate which contains the tutorial.

Creates a boilerplate which contains the TodoMVC application that utilizes LayoutManager.

Scaffolds out a Boilerplate project which contains the GitHub Viewer application source code.

Scaffolds out a Boilerplate project which contains the Movie Trackr application source code.

These commands help you maintain your project.

Ensures all your code conforms to JSHint.

Shows a tree of your application's modules and dependencies.

These commmands help you build your application.

Lints all your JavaScript, compiles all your templates to JST (JavaScript Templates), builds your application using RequireJS build tool (figures out dependencies and concatenates all files), compiles all Stylus and LESS files and concatenates all CSS files together, and then finally concatenates the templates and application together. This task also swaps out RequireJS for Almond (signficantly smaller filesize RequireJS shim).

Everything that debug command does, except the final tasks here are minified CSS and minified JavaScript.

Removes all files inside dist/ directory.

Compiles handlebars templates - this requires setup.

Compiles all templates as underscore template functions and outputs them to dist/debug/templates.js.

Compiles LESS stylesheets.

Minifies your CSS into dist/release/index.css.

Builds out your application using the defaults specified into the root grunt.js file.

Will by default run with normal files perfect for development and debugging.

This command serves the same files excepts that your application is mapped to the dist/debug directory. This is mostly useful for detecting issues with the build, since files are not minified.

This command will serve the same was debug except mapping to dist/release instead. This setup is how your application should be deployed.

Parses a valid CSS file for @imports and concatenates them into an output file. Will automatically build stylus files as it encounters them.

Sample configuration that has styles placed in assets/css:

styles: {
  // Output stylesheet file.
  "dist/debug/index.css": {
    // Main CSS source file, containing the @imports.
    src: "assets/css/index.css",

    // If you are using a path other than `app/styles` ensure this is updated.
    prefix: "assets/css/",

    // Relative path for `@imports`.
    paths: ["assets/css"],

    // Add additional stylesheets.
    additional: ["assets/css/production-fixes.css"]
  }
},

Copyright (c) 2012 Tim Branyen (@tbranyen)
Licensed under the MIT license.