/suspenders

A Rails 4 template with our standard defaults, ready to deploy to Heroku.

Primary LanguageRubyMIT LicenseMIT

Suspenders Build Status

Suspenders is the base Rails application used at thoughtbot.

Suspenders boy

Installation

First install the suspenders gem:

gem install suspenders

Then run:

suspenders projectname

This will create a Rails 4.0 app in projectname.

By default this script creates a new git repository. See below if you want to use it against an existing repo.

Gemfile

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

It includes application gems like:

And gems only for staging and production like:

And testing gems like:

Other goodies

Suspenders also comes with:

Suspenders fixes several of Rails' insecure defaults:

  • Suspenders uses Unicorn instead of WEBrick, allowing less verbose Server headers.
  • Suspenders is configured to pull your application secret key base from an environment variable, which means you won't need to risk placing it in version control.

Heroku

You can optionally create Heroku staging and production apps:

suspenders app --heroku true

This:

  • Creates a staging and production Heroku app
  • Sets them as staging and production Git remotes
  • Configures staging with RACK_ENV and RAILS_ENV environment variables set to staging

Git

This will initialize a new git repository for your Rails app. You can bypass this with the --skip-git option:

suspenders app --skip-git true

GitHub

You can optionally create a GitHub repository for the suspended Rails app. It requires that you have Hub on your system:

curl http://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
suspenders app --github organization/project

This has the same effect as running:

hub create organization/project

Dependencies

Suspenders requires Ruby 1.9.2 or greater.

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

Use OS X GCC Installer for Snow Leopard (OS X 10.6).

Use Command Line Tools for XCode for Lion (OS X 10.7) or Mountain Lion (OS X 10.8).

We use Capybara Webkit for full-stack Javascript integration testing. It requires QT. Instructions for installing QT are here.

PostgreSQL needs to be installed and running for the db:create rake task.

Issues

If you have problems, please create a Github Issue.

Contributing

Please see CONTRIBUTING.md for details.

Credits

thoughtbot

Suspenders is maintained and funded by thoughtbot, inc.

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

License

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