Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Gets your Rails app ready for Backbone.js action. Rails 3.1 and 3.0.x compatible
branch: master

This branch is 14 commits behind gertig:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
vendor/assets/javascripts
.gitignore
.rvmrc
Gemfile
README.md
Rakefile
backbonejs-rails.gemspec

README.md

Installation

Add the following to your Gemfile:

gem "backbonejs-rails", "~> 0.0.5"

Then use Bundler to install:

$ bundle install

Usage

$ rails g backbonejs:install

Optionally you can add -ich to the end of that command to have icanhaz.js included.

What Does it do?

Rails 3.1

backbonejs-rails adds the necessary libraries to your Rails app for using backbone.js. Also, under your assets/javascripts folder it will create the following folder structure:

/backone
  /models
  /routers
  /views

The gem includes the following files in its vendor/assets/javascripts folder, which means you can use any of them in your application.js file by adding something like

//= require underscore 

after this line:

//= require jquery
  • backbone.js
  • underscore.js
  • icanhaz.js
  • json2.js

Rails 3.0

backbonejs-rails is similar to jquery-rails. It adds the Javascript files that you need to create an application that uses backbone.js as a JavaScript MVC. This gem will get the most recent version of these files from their master branches on github.

These are:

  • backbone.js
  • backbone.min.js
  • underscore.js
  • underscore.min.js
  • json2.js

For templates I have included ICanHaz.js which you can optionally include by doing the following

$ rails g backbonejs:install -ich 
  • icanhaz.js
  • icanhaz.min.js

Upon installation the files are added to your javascript defaults so that you can still use the following in your views/layouts/application.html.erb file:

<%= javascript_include_tag :defaults %>

What else?

It also creates a file called "config/initializers/backbone.rb" which contains the line:

ActiveRecord::Base.include_root_in_json = false

Which is what you need to return JSON to Backbone the way it likes it. Otherwise you would need to do something like this:

def create
    render :json => Person.create(:name => params[:name], :age => params[:age])
end

You can find my screencast on Backbone.js and Rails 3 here

Something went wrong with that request. Please try again.