phongnh / brewhouse-rails-template

A base rails app with good gems and config

Brewhouse Rails Template

This is the base Rails app used at Brewhouse.

Usage

Assuming you want to create "my-rails-app":

1 - Clone this repo:

git clone [email protected]:BrewhouseTeam/brewhouse-rails-template.git my-rails-app

2 - Bootstrap your app (prepare config files etc...):

cd my-rails-app && ./bootstrap my-rails-app

What's in there?

You'll find the gems and configuration niceties that we use on most rails app we work on.

The basics

• devise with a User model setup and mailer previews available at /rails/mailers
• simple_form setup for bootstrap 3
• virtus for building services (see app/services/service.rb)
• schema_auto_foreign_keys for a robust data layer where orphan records are not a thing.
• sidekiq with dashboard at /sidekiq
• bootstrap-sass with a couple of defaults in app/assets/styelsheets/_variables.scss
• roadie-rails to inline css in emails so that GMail picks up the styles.

Dev env

• dotenv-rails to store config and secrets in env variables
• letter_opener to open emails in the browser in dev env
• factory_girl
• spring bin-stubs in ./bin (ProTip: Add ./bin to your $PATH)

Test

• rspec for unit testing
• cucumber with capybara-webkit and capybara-screenshot for integration tests
• simplecov because test coverage matters

Production

• puma 'cause it's fast
• rails_12factor to run the app on Heroku
• heroku-deflater to compress assets
• rollbar to get notified about errors
• newrelic_rpm to monitor performances
• app.json will setup add-ons, environment variables and run migrations when you deploy to Heroku