Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 4.39 KB

README.md

File metadata and controls

101 lines (76 loc) · 4.39 KB
Raw

Rails 6 Starter App

Build Status Code Climate Coverage Status

Deploy

This is an opinionated starter web application based on the following technology stack:

Starter App is deployable on Heroku. Demo: https://ruby3-rails6-bootstrap-heroku.herokuapp.com/

Gemfile also contains a set of useful gems for performance, security, api building...

Thread safety

We assume that this application is thread safe. If your application is not thread safe or you don't know, please set the minimum and maximum number of threads usable by puma on Heroku to 1:

$ heroku config:set RAILS_MAX_THREADS=1

Master Key

Rails 5.2 introduced encrypted credentials.

The master key used by this repository is:

02a9ea770b4985659e8ce92699f218dc

DO NOT SHARE YOUR MASTER KEY. CHANGE THIS MASTER KEY IF YOU ARE GOING TO USE THIS REPO FOR YOUR OWN PROJECT.

Heroku Platform API

This application supports fast setup and deploy via app.json:

$ curl -n -X POST https://api.heroku.com/app-setups \
-H "Content-Type:application/json" \
-H "Accept:application/vnd.heroku+json; version=3" \
-d '{"source_blob": { "url":"https://github.com/diowa/ruby3-rails6-bootstrap-heroku/tarball/main/"} }'

More information: Setting Up Apps using the Platform API

Recommended add-ons

Heroku's Production Check recommends the use of the following add-ons, here in the free version:

$ heroku addons:create newrelic:wayne # App monitoring
$ heroku config:set NEW_RELIC_APP_NAME="Rails 6 Starter App" # Set newrelic app name
$ heroku addons:create papertrail:choklad # Log monitoring

Tuning Ruby's RGenGC

Generational GC (called RGenGC) was introduced from Ruby 2.1.0. RGenGC reduces marking time dramatically (about x10 faster). However, RGenGC introduce huge memory consumption. This problem has impact especially for small memory machines.

Ruby 2.1.1 introduced new environment variable RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR to control full GC timing. By setting this variable to a value lower than the default of 2 (we are using the suggested value of 1.3) you can indirectly force the garbage collector to perform more major GCs, which reduces heap growth.

$ heroku config:set RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR=1.3

More information: Change the full GC timing