README.md

README

Template for new Rails projects.

Getting started

To get going clone this repository and perform the following steps:

1. Clone this repository
2. You can now run scripts/setup, which will help you in configuring the template. Alternatively perform all of the following steps manually.
3. Change application name in config/application.rb.
4. Update database.yml to reflect the new application name.
5. If you plan on using Figaro, copy config/application.yml.example to config/application.yml.
6. If you don't plan on tracking the template, you can remove the .git directory. Otherwise you can rename the remote:

   $ git remote rename origin rails_new

7. Add your new remote as appropriate.

Optional configurations

• If you want to use AirBrake, make sure the following 2 environment variables are set:
  • AIRBRAKE_PROJECT_ID
  • AIRBRAKE_API_KEY
• New Relic is pre configured in config/newrelic.yml, but you need to comment in the environment variables for it work on Heroku (lines 10 and 17).

Contents

All of the following have been installed and pre-configured.

Base system

• Rails 5.1.0.pre1
• Ruby 2.3.4
• pg for ActiveRecord
• The app is preconfigured for Google Analytics, just add GOOGLE_ANALYTICS_ID to the environment.

General

• active_model_serializers
• bootstrap-sass
• draper
• figaro
• pundit
• sidekiq

Development

• foreman
• newrelic_rpm
• pry
• pry-byebug
• pry-doc
• RuboCop

Test

• bullet
• bundler-audit
• capybara
• database_cleaner
• devise
• factory_girl_rails
• high_voltage
• memory_profiler
• poltergeist
• rack-mini-profiler
• shoulda-matchers
• spring-commands-rspec
• webmock

Production

• rails_12factor
• airbrake
• rake-timeout
• lograge

Removed

The following default Rails gems have been removed:

• coffee-rails
• jbuilder