Skip to content

Installation

Tim Branyen edited this page Jul 26, 2013 · 28 revisions

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

Using the Yeoman generator (Preferred method)

In order to use the scaffolding tool, you will need to install Node.js. Once that's done, you need to install some packages:

# Install any of these dependencies that you do not currently have.
# Please wait until process exits.
npm install -gq generator-bbb

# If for some reason the above command did not seem to correctly install all
# dependencies, run:
npm install -gq yo grunt-cli bower jamjs

Most of these packages are there to help you build, test and manage assets in your project. Only yoand generator-bbb really are related to the scaffolding.

To initialize a new project, simply run:

yo bbb my-project/

This will prompt you with some question about your preferences, then build 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 gets you started with the most recent commit.

git clone https://github.com/backbone-boilerplate/backbone-boilerplate.git my-project --depth 1