ptn / rails4_blank_app

A Rails 4 app with the minimum configuration and default settings so I can start hacking right away

Rails4 Blank App

This app contains just the minimum configuration needed to start coding right away on the things that matter. It's easier for me to maintain than a rails template.

Thanks

• to foca for this great idea! This app is an adapted version of the Blank Slate app.
• to Xenda and frodsan for their own application template, I stole good ideas from them.

How to use

$ git clone https://github.com/Florent2/rails4_blank_app your_app_name
$ your_app_name/bin/init

Customizations

• a README boilerplate with installation, deployment, development and test sections. On installation it replaces the README.md file you are currently reading
• secret_key_base is loaded from the unversioned .env file through the dotenv-rails gem (why it is important)
• an initializer aborts the application initialization if a ENV variable listed in .env.example is missing
• PostgreSQL is the selected database
• config/database.yml is unversioned, this allows different developers to use different credentials locally, and avoid any risk of versioning db production credentials
• a PagesController with a home view to which points the root route
• test and development logs are automatically rotated to save disk space
• use Bootstrap 3 (without gem)
• layout includes flash messages display
• always raise an exception when an unpermitted attribute is trying to be set
• use marco-polo to display current Rails env && application name in console prompt

For development

• guard-livereload and rack-livereload to have app asset changes apply live in the browser without a browser extension
• Overcommit to enforce automated checks before commits
• Better Errors for more useful error pages
• QuickLog for nice debugging statements
• Quiet Assets to mute assets pipeline log messages
• Jazz Hands (with Hirb enabled by default) for a better rails console
• Guard-CTags-Bundler to automatically update ctags for projet files and gems from project's bundle
• dotenv to load env variables from the .env. file
• byebug for the debugger (available in the test environment too)
• did_you_mean to get clues about correct method name when method name errors

For tests

• single_test to invoke single tests with rakish syntax

TODOs

• user http://www.youtube.com/watch?v=UYOX6OIp_FE instead of dotenv-rails
• add Rubocop and Rubocop config file
• add a page_title helper (flutie)
• add a pre commit hook that aborts commit if byebug is left in a file
• use https://github.com/schneems/sprockets_better_errors ?