Overview

This template bootstraps a Ruby on Rails project beyond what you get with default project generation (i.e. rails <project name>). This template can be applied to a fresh or existing Ruby on Rails application. That said, it might be best if you apply this template to a fresh setup since some original files are overwritten and/or deleted.

Features

The following highlights the changes that will be made to your Ruby on Rails app:

• Installs jQuery 1.3.2.
• Installs jQuery UI 1.7.2.
• Installs jQuery Validation 1.5.2.
• Installs jQuery Table Sorter 2.0.3.
• Installs jQuery Block UI 2.26.
• Installs jQuery jGrowl 1.1.2.
• Removes the default Prototype/Scriptaculous libraries.
• Installs a default application.html.erb file with a basic but structured site layout.
• Installs a default Blueprint CSS theme.
• Installs a jQueryUI theme to compliment the Blueprint CSS theme.
• Installs default application graphics.
• Adds the REST gem requirement.
• Adds the LESS gem requirement.
• Adds the Acts as State Machine (AASM) gem requirement.
• Adds the Acts as List gem requirement.
• Adds the Awesome Nested Set gem requirement.
• Adds the AndAnd gem requirement.
• Adds the Will Paginate gem requirement.
• Adds the RedCloth gem requirement.
• Adds the Paperclip gem requirement.
• Adds the RSpec gem requirement.
• Adds the RSpec for Rails gem requirement.
• Adds the Cucumber gem requirement.
• Adds the Webrat gem requirement.
• Adds the Metric Fu gem requirement.
• Adds the Railroad gem requirement.
• Adds the Bullet gem requirement.
• Installs the More plugin.
• Installs the Custom Error Message plugin.
• Installs the Blue Ridge plugin.
• Installs default configuration initializers.
• Installs a rake script for building Railroad diagrams.
• Installs a rake script that enhances seeding/reseeding of database data.
• Installs a namespaced public controller.
• Installs default view helpers.
• Installs OmniGraffle documentation for site layout and structure.
• Provides site navigation with dynamic controller detection and menu selection.
• Provides nested drop down menu support as inspired by Simple jQuery Dropdowns.

License

Copyright © 2009 Brooke Kuhlmann of Berserk Technologies. See the included LICENSE for more info.

History

See the CHANGELOG file for more info.

Requirements

• MacOS/UNIX (might work on Windows but haven’t tested).
• Ruby Gems 1.3.x or higher.
• Applied the Ruby Gem Setup script or have at least installed all gems listed above.

Usage

Open a terminal window and execute one the following command lines depending on your version preference:

Current Version (stable)

  rails demo -m http://github.com/aeonscope/rails_setup_template/raw/v1.0.0/template.rb

Master Version (possible unstable, use at your own risk)

  rails demo -m http://github.com/aeonscope/rails_setup_template/raw/master/template.rb

Notes

It is recommended that you move the following gem requirements from the config/environment.rb to the config/environments/test.rb file after running the template:

• rspec
• rspec-rails
• cucumber
• webrat
• metric_fu

…and move the following gem requirement from the config/environment.rb to the config/environments/development.rb:

• railroad

To generate Railroad diagrams, view the related Rake tasks via the following command:

  rake -T | grep diagram

Issues

• Railroad - For Rails 2.3.x, generating controller diagrams will fail due to a Railroad ApplicationController bug.

Contact/Feedback/Issues

• Berserk Technologies - Company web site.
• Aeonscope - Personal web site.
• Twitter - Short bursts of insight and/or noise.