Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby JavaScript
Branch: ember-generator
Pull request Compare This branch is 693 commits behind emberjs:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
vendor
.gitignore
.gitmodules
Gemfile
README.md
Rakefile
ember-rails.gemspec

README.md

ember-rails Build Status

ember-rails allows you to include Ember.JS into your Rails 3.x application.

The gem will also pre-compile your handlebars templates when building your asset pipeline. It includes development and production copies of Ember.

You can see an example of how to use the gem here

Getting started

Add the gem to your application Gemfile:

gem "ember-rails"

Run bundle install and add the following line to app/assets/javascripts/application.js:

//= require ember

If yopu just want to use Ember Metal (no View or Handlebars support) you can use:

//= require ember-runtime

Ember-rails also provides a way to run Ember in development mode, you can switch out your require statements to use the dev copies like so:

//= require ember-dev

If you want to copy ember to your own project, you can use the inbuilt generator

rails g ember_rails:install

If you want to use the latest and greatest Ember, you can use the generator to download and compile the latest version for you.

rails g ember_rails:install --head

Ask Rails to serve HandlebarsJS and pre-compile templates to Ember by putting each template in a dedicated ".js.hjs" or ".handlebars" file (e.g. app/assets/javascripts/templates/admin_panel.handlebars) and including the assets in your layout:

<%= javascript_include_tag "templates/admin_panel" %>

Bundle all templates together thanks to Sprockets, e.g create app/assets/javascripts/templates/all.js with:

//= require_tree .

Now a single line in the layout loads everything:

<%= javascript_include_tag "templates/all" %>

Note on Patches/Pull Requests

  1. Fork the project.
  2. Make your feature addition or bug fix.
  3. Add tests for it. This is important so I don't break it in a future version unintentionally.
  4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  5. Send me a pull request. Bonus points for topic branches.
Something went wrong with that request. Please try again.