end config and add readme

.overcommit.yml

@@ -0,0 +1,8 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop']
+
+PrePush:
+  Brakeman:
+    enabled: true

.rubocop

@@ -0,0 +1,3 @@
+--rails
+--extra-details
+--auto-correct

.rubocop.yml

@@ -0,0 +1,21 @@
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 100
+
+AllCops:
+  Exclude:
+    - db/migrate/*
+    - db/schema.rb
+    - bin/*
+    - node_modules/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - config/environments/development.rb
+
+Rails/Output:
+  Exclude:
+    - db/seeds.rb
+

Gemfile.tt

@@ -41,6 +41,15 @@ group :development do
   gem 'table_print'
   gem 'xray-rails'
 
+  gem 'brakeman', require: false
+  gem 'overcommit'
+  gem 'rubocop', require: false
+
+  gem 'guard'
+  gem 'guard-bundler', require: false
+  gem 'guard-livereload', require: false
+  gem 'rack-livereload'
+
   gem 'better_errors'
   gem 'binding_of_caller'
   gem 'web-console'<%= gemfile_requirement('web-console') %>

Procfile.dev

@@ -0,0 +1 @@
+web: bundle exec puma -C config/puma.rb

README.md

@@ -0,0 +1,139 @@
+# Modern Rails Template
+
+## Description
+
+This is the rails template I used for my Rails 5.2 projects as a freelance developer. Its goal is to allow to begin new rails application easily, with a modern and efficient configuration and with good set of defaults. The project is still very much a work in progress. So do not expect it to be 100% bug free. [Contributions][] are really welcome.
+
+This project is inspired by the template developed by Matt Brictson. Have a look [here][] to compare both.
+
+## Requirements
+
+This template currently works with:
+
+* Rails 5.2.x
+* PostgreSQL
+
+## Installation
+
+_Optional._
+
+To make this the default Rails application template on your system, create a `~/.railsrc` file with these contents:
+
+```
+--skip-coffee
+--webpack
+-d postgresql
+-T
+-m https://raw.githubusercontent.com/damienlethiec/modern-rails-template/master/template.rb
+```
+
+## Usage
+
+To generate a Rails application using this template, pass the options below to `rails new`, like this:
+
+```
+rails new blog \
+  --skip-coffee \
+  --webpack \
+  -d postgresql \
+  -T \
+  -m https://raw.githubusercontent.com/damienlethiec/modern-rails-template/master/template.rb
+```
+
+_Remember that options must go after the name of the application._ The only database supported by this template is `postgresql`.
+
+If you’ve installed this template as your default (using `~/.railsrc` as described above), then all you have to do is run:
+
+```
+rails new blog
+```
+
+## What does it do?
+
+The template will perform the following steps:
+
+1. Ask for which option you want in this project
+1. Generate your application files and directories
+1. Add useful gems and good configs
+1. Add the optional config specified
+1. Commit everything to git
+
+## What is included?
+
+Below is an extract of what this generator does. You can check all the features by following the code, especially in `template.rb` and in the `Gemfile`.
+
+### Standard configuration
+
+* Change the default generators config (cf `config/initializers/generators.rb`)
+* Setup [I18n][] for English and French
+* Improve the main layout (cf `app/views/layouts/application.haml.erb`) to include webpack in the asset pipeline
+* Create a basic PagesController to have something to show when the app launch
+* Add a [Procfile][] for dev and a Procfile for production to manage the different processes you need to manage in a modern web application.
+* Setup [UUID][] as the primary key for Active Record
+* Add Javascript ([ESLint][]) and CSS ([Stylelint][]) linters with webpack
+* Add and configure the [friendly_id][] gem for slugging
+* Add and configure the [annotate][] gem to add useful comments in our models
+* Add and configure the [bullet][] gem to track N+1 queries
+* Add and configure the [rails_erd][] gem to generate automatically a schema of our database relationships
+* Add and configure the [sidekiq][] gem for background jobs. You can access the sidekiq dashboard in the app at `/sidekiq` (don't forget to limit its access in the routes if needed)
+* Add and configure [rubocop][] for style and [brakeman][] for security and add them to [overcommit][] git hooks
+* Add livereload for view and automatic bundle installs using [guard][], [guard-livereload][] and [guard-bundler][]
+* Add [better-error][] and [xray-rails][] for easier debugging
+* Add [awesome-print][] and [table-print][] for easier exploration in the terminal
+* Setup git with [git-flow][]
+
+### Additional options
+
+When you launch a new rails app with the template, a few questions will be asked. Answer 'y' or 'yes' to unable the given option.
+
+* If you need authentication, the [devise][] gem can be added and configured directly
+* If you also need authorization, [pundit][] can be added and configured too.
+* You can choose to use [Haml][] instead of `erb`
+* If you feel adventurous, you can choose to use the [komponent][] gem and build your front-end following the workflow describe in this great [article][]
+* You can include [tailwindcss] in your project. The configure is inspired by the following Gorails [episode][]
+* Finally, you can choose to create a Github repository for you project and push it directly.
+
+## How does it work?
+
+This project works by hooking into the standard Rails application templates system, with some caveats. The entry point is the `template.rb` file in the root of this repository.
+
+Normally, Rails only allows a single file to be specified as an application template (i.e. using the `-m <URL>` option). To work around this limitation, the first step this template performs is a `git clone` of the `damienlethiec/modern-rails-template` repository to a local temporary directory.
+
+This temporary directory is then added to the `source_paths` of the Rails generator system, allowing all of its ERb templates and files to be referenced when the application template script is evaluated.
+
+Rails generators are very lightly documented; what you’ll find is that most of the heavy lifting is done by [Thor][]. The most common methods used by this template are Thor’s `copy_file`, `template`, and `gsub_file`.
+
+## Contributing
+
+If you want to contribute, please have a look to the issues in this repository and pick one you are interested it. You can then clone the project and submit a pull request. We also welcome new idea and, of course, bug reports.
+
+[thor]: https://github.com/erikhuda/thor
+[here]: https://github.com/mattbrictson/rails-template
+[contributions]: https://github.com/damienlethiec/modern-rails-template#contributing
+[procfile]: http://guides.rubyonrails.org/i18n.html
+[i18n]: http://guides.rubyonrails.org/i18n.html
+[uuid]: https://lab.io/articles/2017/04/13/uuids-rails-5-1/
+[eslint]: https://eslint.org/
+[stylelint]: https://stylelint.io/
+[friendly_id]: https://github.com/norman/friendly_id
+[annotate]: https://github.com/ctran/annotate_models
+[bullet]: https://github.com/flyerhzm/bullet
+[rails_erd]: https://github.com/voormedia/rails-erd
+[sidekiq]: https://github.com/mperham/sidekiq
+[rubocop]: http://rubocop.readthedocs.io/en/latest/
+[brakeman]: https://brakemanscanner.org/
+[overcommit]: https://github.com/brigade/overcommit
+[guard]: https://github.com/guard/guard
+[guard-livereload]: https://github.com/guard/guard-livereload
+[guard-bundler]: https://github.com/guard/guard-bundler
+[better_errors]: https://github.com/charliesome/better_errors
+[xray-rails]: https://github.com/brentd/xray-rails
+[awesome_print]: https://github.com/michaeldv/awesome_print
+[table-print]: https://github.com/arches/table_print
+[git-flow]: https://github.com/nvie/gitflow
+[devise]: https://github.com/plataformatec/devise
+[pundit]: https://github.com/varvet/pundit
+[haml]: http://haml.info/
+[komponent]: https://github.com/komposable/komponent
+[article]: https://evilmartians.com/chronicles/evil-front-part-1
+[episode]: https://gorails.com/episodes/tailwind-css-framework-with-rails

README.md.tt

@@ -1,7 +1,17 @@
 # <%= app_name %>
 
-This is a Rails <%= Rails::VERSION::MAJOR %> app.
+This is a Rails <%= Rails::VERSION::MAJOR %> app created using [modern-rails-template][]. Please check README of the template repository to see the features available out of the box.
 
-## Documentation
+## How to use this project
 
-Use [gitflow](https://github.com/nvie/gitflow), more info [here](http://nvie.com/posts/a-successful-git-branching-model/)
+* Use [gitflow][] for version control. More info [here].
+* We advise you to use [overmind][] to launch your processes in development. You just need to run `overmind s -f Procfile.dev`. Of course, another process manager, like [foreman][], would work too.
+* We advise you to deploy to [Heroku][]. Do not forget to add the [Redis] add-on.
+
+[modern-rails-template]: https://github.com/damienlethiec/modern-rails-template
+[git-flow]: https://github.com/nvie/gitflow
+[here]: http://nvie.com/posts/a-successful-git-branching-model/
+[overmind]: https://github.com/DarthSim/overmind
+[foreman]: https://github.com/ddollar/foreman
+[heroku]: https://www.heroku.com/
+[redis]: https://devcenter.heroku.com/articles/heroku-redis

config/routes.rb

@@ -1,6 +1,6 @@
 Rails.application.routes.draw do
 
-  scope '(:locale)', locale: /fr|es/ do
+  scope '(:locale)', locale: /fr/ do
     root to: 'pages#home'
   end
 end