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', :group => :assets

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.

Install (requires directives to Asset pipeline.)

Usage:

rails g bootstrap:install

Layout (generates Twitter Bootstrap compatible layout.) - (Slim supported)

Usage:

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

Example:

rails g bootstrap:layout application fixed

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.

$ ->
  $(".alert-message").alert()
$ ->
  $(".tabs").button()
$ ->
  $(".carousel").carousel()
$ ->
  $(".collapse").collapse()
$ ->
  $(".dropdown-toggle").dropdown()
$ ->
  $("#myModal").modal options
$ ->
  $("#example").popover options
$ ->
  $("#navbar").scrollspy()
$ ->
  $("#myTab").tab "show"
$ ->
  $("#example").tooltip options
$ ->
  $(".typeahead").typeahead()

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"

Changelog

• Version 0.0.5 deprecated
• Asset files updated to latest and removed version numbers
• Implemented Less::Rails Railtie to use with LESS
• Fixed railtie to only initialize Less when installed
• New branch for the static version of Bootstrap (w/o Less) - check static branch
• Added path to support heroku deploy
• Rake precompile issue fixed
• Updated asset files to 1.4.0
• Updated dependency less-rails (now requires 2.1.0)
• Added generators
• Fixed generators
• Fixed class name conflicts from (bootstrap.js.coffee)
• Fixed jquery-rails gem version dependency
• Updated asset files
• Added new generators (install, layout and themed)
• Compability to Rails 3.2
• Transitioning to 2.0

Contributors & Patches & Forks

• Daniel Morris
• Bradly Feeley
• Guilherme Moreira
• Alex Behar
• Brandon Keene
• Anthony Corcutt
• Colin Warren
• Giovanni Cappellotto
• Masakuni Kato
• Gudleik Rasch

Future

• Writing tests (not implemented yet)
• Markup Helpers (alert, tabs, pagination, breadcrumbs etc.)

Credits

Seyhun Akyürek - seyhunak [at] gmail com

Follow me on Twitter Follow me on Google+

Thanks

Twitter Bootstrap and all twitter-bootstrap-rails contributors 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.