Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
71 lines (47 sloc) 2.7 KB
Suspenders is a base Rails application that you can upgrade.
![Suspenders boy](http://media.tumblr.com/1TEAMALpseh5xzf0Jt6bcwSMo1_400.png)
Installation
------------
First install the suspenders gem:
gem install suspenders
Then run:
suspenders create projectname
This will create a Rails 3 app in `projectname'. This script creates a new
new git repository. It is not meant to be used against an existing repo.
Gemfile
-------
To see the latest and greatest gems, look at Suspenders'
[template/trout/Gemfile](https://github.com/thoughtbot/suspenders/blob/master/template/trout/Gemfile),
which will be copied into your projectname/Gemfile.
It includes application gems like:
* [Paperclip](https://github.com/thoughtbot/paperclip) for file uploads
* [Formtastic](https://github.com/justinfrench/formtastic) for better forms
* [Hoptoad Notifier](https://github.com/thoughtbot/hoptoad_notifier) for exception notification
* [Flutie](https://github.com/thoughtbot/flutie) for default CSS styles
* [Clearance](https://github.com/thoughtbot/clearance) for authentication
And testing gems like:
* [Cucumber, Capybara, and Akephalos](http://robots.thoughtbot.com/post/1658763359/thoughtbot-and-the-holy-grail) for integration testing, including Javascript behavior
* [RSpec](https://github.com/rspec/rspec) for awesome, readable isolation testing
* [Factory Girl](https://github.com/thoughtbot/factory_girl) for easier creation of test data
* [Shoulda](http://github.com/thoughtbot/shoulda) for frequently needed Rails and RSpec matchers
* [Timecop](https://github.com/jtrupiano/timecop) for dealing with time
* [Bourne](https://github.com/thoughtbot/bourne) and Mocha for stubbing and spying
Other goodies
-------------
Suspenders also comes with:
* [jQuery](https://github.com/jquery/jquery) for Javascript pleasantry
* Rails' flashes set up and in application layout.
* A few nice time formats.
See [template/files](https://github.com/thoughtbot/suspenders/blob/master/template/files) to
see what is generated one-time.
Dependencies
------------
Some gems included in Suspenders have native extensions. You should have GCC installed on your
machine before running Suspenders.
If you're running OS X, we recommend the [GCC OSX installer](https://github.com/kennethreitz/osx-gcc-installer).
We use [Capybara Webkit](https://github.com/thoughtbot/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](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-QT).
Issues
------
If you have problems, please create a [Github issue](https://github.com/thoughtbot/suspenders/issues).