Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Skeleton for new Rails based projects
Ruby CSS HTML Other

Merge branch 'ruslankhaertdinov-add-metamagic-295'

* ruslankhaertdinov-add-metamagic-295:
  [#295] Add metamagic gem
latest commit 3283dfcba8
@timurvafin timurvafin authored

README.md

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.2.

Application Gems

Development Gems

  • Thin 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 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

Testing Gems

Initializers

  • 01_config.rb - shortcut for getting application config with app_config
  • mailer.rb - setup default hosts for mailer from configuration
  • requires.rb - automatically requires everything in lib/ & lib/extensions

Scripts

  • 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

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://github.com/fs/rails-base.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 git@github.com:[MY-GITHUB-ACCOUNT]/[MY-NEW-PROJECT].git
    git push -u origin master
  3. Run setup script

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

    bin/ci
  5. Run app

    bin/server
  6. Update README

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

    mv doc/README_TEMPLATE.md README.md
    # update README.md
    git commit -am "Update README.md"

Credits

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

Flatstack

Something went wrong with that request. Please try again.