Twitter Bootstrap for Rails 3.1 Asset Pipeline

Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.

twitter-bootstrap-rails project integrates Bootstrap CSS toolkit for Rails 3.1 Asset Pipeline

Installing Gem

Include Bootstrap in Gemfile;

gem 'twitter-bootstrap-rails'

or you can install from latest build;

gem 'twitter-bootstrap-rails', :git => 'http://github.com/seyhunak/twitter-bootstrap-rails.git'

You can run bundle from command line

bundle install

Installing to App (using Generators)

You can run following generators to get started with Twitter Bootstrap quickly.

  1. Install (requires directives to Asset pipeline.)

Usage:

 rails g bootstrap:install
  1. Layout (generates Twitter Bootstrap compatible layout.)

Usage:

 rails g bootstrap:layout [LAYOUT_NAME] [*fixed or fluid] [options]

Example:

 rails g bootstrap:layout application fixed
  1. Themed (generates Twitter Bootstrap compatible scaffold views.)

Usage:

 rails g bootstrap:themed [RESOURCE_NAME] [LAYOUT] [options]

Example:

 rails g scaffold post title:string description:text
 rails g bootstrap:themed posts

Using with Less

Bootstrap was built with Preboot, an open-source pack of mixins and variables to be used in conjunction with Less, a CSS preprocessor for faster and easier web development.

Using stylesheets with Less

You have to require Bootstrap LESS (bootstrap.less) in your application.css

/*
 *= require twitter/bootstrap
*/

/* Your stylesheets goes here... */

Now, you can override LESS files provided by Twitter Bootstrap

 @import "twitter/bootstrap";

 // Baseline grid
 @basefont:          13px;
 @baseline:          18px;

Using Javascripts

You have to require Bootstrap JS (bootstrap.js) in your application.js

//= require twitter/bootstrap

$(document).ready(function(){
  /* Your javascripts goes here... */
});

Using Coffeescript (optionally)

Using Twitter Bootstrap with the CoffeeScript is easy. twitter-bootstrap-rails generates a "bootstrap.js.coffee" file for you to /app/assets/javascripts/ folder.

    $ ->
        $("body > .topbar").scrollSpy()
    $ ->
        $(".tabs").tabs()
    $ ->
        $("a[rel=twipsy]").twipsy live: true
    $ ->
        $("a[rel=popover]").popover offset: 10
    $ ->
        $(".topbar-wrapper").dropdown()
    $ ->
        $(".alert-message").alert()
    $ ->
        domModal = $(".modal").modal(
            backdrop: true
            closeOnEscape: true
        )
        $(".open-modal").click ->
            domModal.toggle()
    $ ->
        $(".btn").button "complete"

Using simple_form and integrating Twitter Bootstrap (optionally)

First, include simple_form in Gemfile;

 gem 'simple_form'

Create initializer for simple_form to ("/config/initializers/simple_form.rb")

Check this gist;

 https://gist.github.com/1479043

Note: Don't forget to reboot server.

Using Static CSS, JS (w/o Less)

twitter-bootstrap-rails has seperate branch (w/o Less) that just serves latest static CSS, JS files.

You can install from latest build (from branch);

gem 'twitter-bootstrap-rails', :git => "git://github.com/seyhunak/twitter-bootstrap-rails.git", :branch => "static"

Credits

Seyhun Akyürek - seyhunak [at] gmail com

Follow me on Twitter

Thanks

Twitter Bootstrap http://twitter.github.com/bootstrap

License

Copyright (c) 2011 Seyhun Akyürek

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.