rails_new

A thoughtfully designed template for building modern Rails apps 🔥

Get started on your new app within minutes instead of hours 🚗💨

Getting started

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

Clone this repository
You can now run bin/configure, which will help you in configuring the template. Alternatively perform all of the following steps manually.
Change application name in config/application.rb.
Update database.yml to reflect the new application name.
Update TODO items in config/environments/production.rb.
If you plan on using Figaro, copy config/application.yml.example to config/application.yml.
ESLint is preconfigured for modern JS with React support (AirBnB styleguide). If you want to use it install packages with npm install, otherwise remove .eslintrc and package.json.
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
```
Add your new remote as appropriate.

Note on Webpacker, the asset pipeline, and ES6

By default ES6 will not work for files in app/assets/javascript since Uglifier will fail to process them. This is why we applied the following change to config/production.rb, which allows you to use ES6 project wide:

-  config.assets.js_compressor = :uglifier
+  config.assets.js_compressor = Uglifier.new(harmony: true)

Also note that for everything to work properly on Heroku, you need to set up your buildpacks like this:

heroku buildpacks:clear
heroku buildpacks:set heroku/nodejs
heroku buildpacks:add heroku/ruby

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

Environment variables

Variable	Comment
GOOGLE_ANALYTICS_ID	Will be added to the main application layout if set
BLOCK_HTTP_TRACE	Disable HTTP TRACE method if set to true/t/1
DATABASE_URL	Used for `production` env, automatically set by Heroku
HTTP_METHOD_BLACKLIST	If you want to block more than just TRACE, e.g. `"TRACE,OPTIONS"`
PORT	Port Puma will listen on, defaults to 3000
RAILS_LOG_TO_STDOUT	Set by Heroku Ruby buildpack, set manually on other platforms if needed
RAILS_MAX_THREADS	Number of Puma threads, defaults to 5

ApplicationDecorator: lightweight alternative to Draper or similar gems.
yard is available in development mode. Use yard doc to generate documentation and yard server --reload or yard server --gems to start a local documentation server.
Favicons were generated with Real Favicon Generator.
There's a custom middleware (Rack::RejectTrace) for completely disabling the HTTP TRACE method as required by certain security audits. It can be enabled via the BLOCK_HTTP_TRACE environment variable.

General

Frontend

All of these are managed by yarn.

Development

Test

Preconfigured for Rails 5.1+ system tests with Rspec. Install the necessary driver with brew install chromedriver and see spec/system/landing_page_spec.rb for an example.
No need to require 'rails_helper, we do it in .rspec
bundler-audit
capybara
factory_bot_rails
shoulda-matchers
spring-commands-rspec
webmock

Production

Removed

The following default Rails gems have been removed:

About

A thoughtfully designed template for building modern Rails apps 🔥 Get started on your new app within minutes instead of hours 🚗💨

Languages

Language:Ruby 83.8%Language:HTML 13.8%Language:JavaScript 2.3%Language:CSS 0.1%Language:Shell 0.0%

mabid / rails_new