/suspenders

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

Primary LanguageRubyMIT LicenseMIT

Suspenders

Build Status Reviewed by Hound

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 app in projectname using the latest version of Rails.

Associated services

Gemfile

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

It includes application gems like:

And development gems like:

  • Dotenv for loading environment variables
  • Pry Rails for interactively exploring objects
  • ByeBug for interactively debugging behavior
  • Bullet for help to kill N+1 queries and unused eager loading
  • Bundler Audit for scanning the Gemfile for insecure dependencies based on published CVEs
  • Web Console for better debugging via in-browser IRB consoles.

And testing gems like:

Other goodies

Suspenders also comes with:

Heroku

Read the documentation on deploying to 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 HONEYBADGER_ENV environment variable set to staging
  • Creates a Heroku Pipeline for review apps
  • Schedules automated backups for 10AM UTC for both staging and production

You can optionally specify alternate Heroku flags:

suspenders app \
  --heroku true \
  --heroku-flags "--region eu --addons sendgrid,ssl"

See all possible Heroku flags:

heroku help create

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:

brew install hub # macOS, for other systems see https://github.com/github/hub#installation
suspenders app --github organization/project

This has the same effect as running:

hub create organization/project

Dependencies

Suspenders requires the latest version of Ruby.

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 Google Chromedriver for full-stack JavaScript integration testing. It requires Google Chrome or Chromium.

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

Redis needs to be installed and running for Sidekiq

Issues

If you have problems, please create a GitHub Issue.

Contributing

See CONTRIBUTING.md.

Thank you, contributors!

License

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

About thoughtbot

thoughtbot

Suspenders is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects. We are available for hire.