kscollective / suspenders Goto Github PK

Suspenders is the base Rails application used at thoughtbot.

First install the suspenders gem:

gem install suspenders

Then run:

suspenders projectname

This will create a Rails 3.1 app in `projectname'. This script creates a new new git repository. It is not meant to be used against an existing repo.

To see the latest and greatest gems, look at Suspenders' template/Gemfile_additions, which will be appended to the default generated projectname/Gemfile.

It includes application gems like:

• Paperclip for file uploads
• Formtastic for better forms
• Hoptoad Notifier for exception notification
• Flutie for default CSS styles
• Bourbon for classy sass mixins
• Clearance for authentication

And testing gems like:

• Cucumber, Capybara, and Capybara Webkit for integration testing, including Javascript behavior
• RSpec for awesome, readable isolation testing
• Factory Girl for easier creation of test data
• Shoulda Matchers for frequently needed Rails and RSpec matchers
• Timecop for dealing with time
• Bourne and Mocha for stubbing and spying
• email_spec for testing emails.

Suspenders also comes with:

• jQuery for Javascript pleasantry
• Rails' flashes set up and in application layout.
• A few nice time formats.

Some gems included in Suspenders have native extensions. You should have GCC installed on your machine before generating an app with Suspenders.

If you're running OS X, we recommend the GCC OSX installer.

We use Capybara Webkit for full-stack Javascript integration testing. It requires you have QT installed on your machine before running Suspenders.

Instructions for installing QT on most systems are available here.

If you have problems, please create a Github issue.

Please see CONTRIBUTING.md for details.

Suspenders is maintained and funded by thoughtbot, inc

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

Suspenders is Copyright © 2008-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.