Skip to content

Installation

tbranyen edited this page Apr 22, 2012 · 28 revisions

Before you can start using the Backbone Boilerplate you need to install it! :D

Installing the dependencies

The Backbone Boilerplate itself has no formal dependencies, but if you wish to use the included build tool, you will need to install Node.js for your platform. Don't worry it's super easy now!

If you would prefer to not use the included build tool, you can simply delete the grunt.js file in the project root.

Node.js

Navigate to: http://nodejs.org/ and click Download. Once you've downloaded scroll down to the Build section to see how to configure and use it.

Installing the Backbone Boilerplate

There are several methods you can use to install the Backbone Boilerplate.

Using the scaffolding tool (Preferred method)

In order to use the build process, you will need to install the grunt-bbb plugin. This will give you access to a bbb command that can be run inside your terminal.

To initialize a new project, simply run:

cd myproject
bbb init

Once you finish providing the name of your namespace, it will build out the entire boilerplate into your directory.

Downloading an archive

The master branch (latest copy) is available from GitHub as a compressed archive in either ZIP or TAR format. Windows users may find the ZIP archive easier to work with and GNU/Linux users may find the TAR format easier to work with.

Using Git

This will download the latest boilerplate into your application directory and clean out all the unnecessary git remnants.

cd myproject
git clone https://github.com/tbranyen/backbone-boilerplate.git .
rm -rf .git*