ruby-boilerplate

author

Arwid Bancewicz arwid.ca

version

0.1

languages

Ruby on Rails, HTML, CSS, Javascript

updated

16 Mar 2011

This is a Ruby on Rails site template using Html5boilerplate, jquery.Page, PIE.htc, Jammit, and Humans.txt. It can be viewed here: sitetemplate.heroku.com. The goal is to create a site template that uses best practices, degrades well with browsers, and optimizes with ease so you can get your project off the ground quickly and right-footed.

Usage

Start your new website:

git clone git@github.com:Arwid/ruby-boilerplate.git <site_name>

View it in your browser:

cd <site_name>
rails s -p 3000 -e development
// visit http://localhost:3000

Requirements

• Rails 3.0.5

• Ruby 1.9.2

Details

HTML5Boilerplate is used as the HTML/CSS/JS base for a fast, robust and future-proof site. It’s HTML is poured into app/views/layouts/application.html.erb and CSS into public/stylesheets/base.css. Instead of using HTML5Boilerplate’s ant script for asset compression, Jammit is used instead which fits in very nicely. jQuery.Page is used to make it very easy to add per-page Javascript.

Here is the core structure (excluding error pages):

• public/

  • apple-touch-icon.jpg

  • favicon.ico

  • humans.txt

  • PIE.htc

  • robots.txt

  • assets/

  • images/

    • embed/

  • stylesheets/

    • base.css

    • handheld.css

    • mylibs/

    • views/

      • layouts/

        • _footer.css

        • _header.css

        • application.css

      • page/

        • home.css

      • shared/

  • javascripts/

    • application.js

    • libs/

      • jquery-1.4.2.min.js

      • modernizr-1.6.min.js

      • dd_belatedpng.min.js

    • mylibs/

      • jquery.Page.js

    • profiling/

License

ruby-boilerplate is covered by the MIT License.