Skip to content
Skeleton for new Rails based projects.
Ruby CSS HTML Other
Find file
Latest commit d780229 @timurvafin timurvafin Merge pull request #415 from ruslankhaertdinov/show-slowest-2-specs
Show 2 slowest specs during specs run
Failed to load latest commit information.
app Make sure decorated models respond to `to_model`
bin show slowest specs only in local env
config fixed flash messages, underfield hints and patched devise to 3.5.4
db User factory generate confirmed user by default
doc Update README template
lib fix confirm attribute usage in slim templates
public Move assets to app directory
spec apply review comments: update CHANGELOG, move profile option into .rs…
.csscomb.json add csscomb configuration
.env.example Fix typo in .env sample: locahost -> localhost
.erdconfig Add Rails ERD for generating entity-relationship diagrams
.gitignore Switch from Thin to Puma
.pryrc.example add gem pry-remote
.rspec apply review comments: update CHANGELOG, move profile option into .rs…
.ruby-version Update ruby and rails
Brewfile Add graphviz to Brewfile apply review comments: update CHANGELOG, move profile option into .rs… more detailed release instructions
Gemfile upgrade Rails to
Gemfile.lock upgrade Rails to
Procfile Switch from Thin to Puma Add new logo in the readme
Rakefile force double quotes in ruby
app.json Add required config vars to app.json Move CanonicalHost and Auth::Basic configuration to initializers

Rails Base

Build Status Test Coverage Code Climate

Rails Base is the base Rails application template used at Flatstack. It's based on Rails 4 and Ruby 2.2.3.

Application Gems

Development Gems

  • Puma as Rails web server
  • Foreman for managing development stack with Procfile
  • Letter Opener for opening mail in the browser instead of sending it
  • Bullet for detecting N+1 queries and unused eager loading
  • Rubocop and Rubocop-Rspec for reporting violations of the Ruby style guide
  • Rails Best Practices for checking the code quality
  • Brakeman for checking application for common security vulnerabilities
  • Pry Rails for interactively exploring objects
  • Bundler Audit for scanning the Gemfile for insecure dependencies based on published CVEs
  • Spring for fast Rails actions via pre-loading
  • Web Console for better debugging via in-browser IRB consoles
  • SCSS-Lint for reporting violations of SCSS coding conventions
  • Coffeelint to keep Coffeescript code clean and consistent
  • Slim-Lint for reporting violations of Ruby style guide in .slim templates
  • Rails ERD for generating a diagram based on application's AR models

Testing Gems


  • mailer.rb - setup default hosts for mailer from configuration
  • requires.rb - automatically requires everything in lib/ & lib/extensions


  • bin/setup - setup required gems and migrate db if needed
  • bin/quality - runs rubocop, brakeman, rails_best_practices and bundle-audit for the app
  • bin/ci - should be used in the CI or locally
  • bin/server - to run server locally

Getting Started

Prepare dependencies

Some gems have native extensions. You should have GCC installed on your development machine.

  • qt - to run specs with Capybara Webkit
  • phantomjs198 - to run Javascript unit tests
  • graphviz - to generate Entity-Relationship Diagram

Setup required dependencies from Brewfile:

brew tap Homebrew/bundle
brew bundle

Bootstrap application

  1. Clone application as new project with original repository named "rails-base". We use depth parameter here in order not to copy the history of changes in base project

    git clone --depth 1 git:// --origin rails-base [MY-NEW-PROJECT]
  2. Create your new repo on GitHub and push master into it. Make sure master branch is tracking origin repo.

    git remote add origin[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
    git push -u origin master
  3. Run setup script

  4. Run test and quality suits to make sure all dependencies are satisfied and applications works correctly before making changes.

  5. Run app

  6. Update README

    Do not forget to update application file with detailed information based on the existing template.

    mv doc/
    # update
    git commit -am "Update"



Out of the box Rails Base ready to be deployed to

  • Heroku Postgres add-on will be used for database.
  • SendGrid add-on required to be able to send emails.
  • NewRelic add-on could be used to monitor application performance.
  • Rollbar add-on could be used to application errors.
heroku create --addons=heroku-postgresql,sendgrid,newrelic,rollbar --remote staging rails-base-example
heroku config:add HOST="" MAILER_SENDER_ADDRESS="" NEW_RELIC_APP_NAME="Rails Base"
git push staging master
heroku run rake db:schema:load
heroku open


Rails Base is maintained by Timur Vafin. It was written by Flatstack with the help of our contributors.

Something went wrong with that request. Please try again.