README.md

Rails Boilerplate

A stock install of Ruby on Rails 3.2 with some commonly used gems and settings already included. Made primarily for my own use, but feel free to fork and use at will. Feedback, issues and pull requests are always welcome.

What's Included

• Rails 3.2 (running on PostgreSQL)
• Powder
• Compass
• Paperclip
• Kumade
• IE Conditional HTML Tag
• SettingsLogic
• Switched default YAML parser (Psych) back to Syck for SettingsLogic to work right (see boot.rb)

Prerequisites

• RVM
• Ruby v1.9.3-p194
• Bunlder
• ImageMagick (required for PaperClip to work)
• Local PostgreSQL server
  • great setup how-to on Stack Overflow if you're new to this

Installation

1. From terminal:

    git clone git://github.com/mklickman/rails-boilerplate.git
    cd rails-boilerplate
    y
    bundle install
    bundle exec compass init rails
    rails generate ie_conditional_tag:install
   

2. Create your local database

   • By default, the app will be looking for "rails-boilerplate_*" (where "*" is your environment). Edit your database.yml file if you want to use different db names.
   • I recommend using Navicat for managing your databases (free version here)

3. Party like it's 1999

"Find and Replace in Project"

Your app name will be set to "RailsBoilerplate", so you'll have to change any instances of 'RailsBoilerplate' and 'rails-boilerplate' to whatever you want your app to be called (in application.rb, for example). Quit whining, I'll write a script for that soon enough.

Still To Do

• Add staging environment
• App renaming script (see above)

Legal

I don't claim to be a Rails expert, so if you have issues, comments, suggestions, or bug fixes feel free to let me know. Forks & pull requests are cool too.