dao42 / rails-template

A best & newest & fastest rails 6.x template for senior rails developer.

dao42/rails-template

dao42/rails-template has supported the newest rails 6.1.x project setup

Maybe the best & newest & fastest rails template for senior rails developer.

It maybe the best starting for your new rails project.

An example built with rails-template: https://github.com/dao42/rails-template-example

Core Idea

dao42/rails-template apply lots of good components for you to make development damn quick.

1. dao42/rails-template keep the newest easily because it's a real Rails Application Template.
2. dao42/rails-template love the newest standard components of Rails 6, using webpacker and remove assets pipeline.
3. dao42/rails-template is out-of-box for your development based on bootstrap4.
4. dao42/rails-template is out-of-box for your deployment based on mina.

How to use

Install dependencies:

• postgresql

  $ brew install postgresql

  Ensure you have already initialized a user with username: postgres and password: postgres( e.g. using $ createuser -d postgres command creating one )

• rails 6

  Using rbenv, update ruby up to 2.7 or higher, and install rails 6.1.x

  $ ruby -v ( output should be 2.7.x or 3.x )
  
  $ gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.com/` (optional, Chinese developer recommend)
  
  $ gem install rails
  
  $ rails -v ( output should be rails 6.1.x )

• yarn

  Install npm, yarn for webpacker( see install document: https://yarnpkg.com/en/docs/install)

  $ yarn --version( output should be 1.6.x or higher )
  
  $ npm config set registry https://registry.npm.taobao.org (optional, Chinese developer recommend)

Then,

1. Add gems.ruby-china.com to your bundle mirrors (optional, Chinese developer recommended)

   $ bundle config mirror.https://rubygems.org https://gems.ruby-china.com

2. Create your own rails app applying rails-template

   $ rails new myapp -m https://raw.githubusercontent.com/dao42/rails-template/master/composer.rb

   Important!! replace myapp to your real project name, we will generate lots of example files by this name.

3. Done! Trying to start it.

   $ rails s

What we do

rails-template apply lots of good components for you to make development damn quick.

1. ActionCable and Turbolinks features are opened by default.

2. Bootstrap4 and font-awesome are integrated to make your products UI easily, it aslo has some example pages for you to quickly start.

3. active_storage and local file mode are opened by default.

4. mina and its plugins are out-of-box for your deployment.

5. slim, simple_form, kaminari, high_voltage are installed.

6. adminlte 3 is ready for your administrator dashboard.

7. rspec, factory_bot_rails, database_cleaner are ready for your testing automation.

8. Zero-down phase-restart mode is out-of-box with mina-ng-puma.

9. monit, nginx example, https ssl example, logrotate, backup example is ready for you.

Other gems integrated in rails-template are worth learning seriously.

Integrated mainly technology stack and gems

• Ruby on Rails 6.0
• bootstrap 4
• font-awesome 5
• figaro
• postgres
• slim
• simple_form
• high_voltage
• active_storage
• sidekiq
• kaminari
• mina
• puma
• rspec
• adminlte 3

Starting with webpacker document

• Starting with webpacker for Rails 6(zh-CN)

Deployment document

• How to deploy to ubuntu 16.10 with rails-template step by step(zh-CN)

Roadmap

• Add AdminLTE as admin dashboard

Projects that using dao42/rails-template

Welcome to pull request here to update this if you choose dao42/rails-template for your new rails app.

• danmai weapp SAAS platform
• dao42 official website
• showmebug

LICENSE

MIT

rails-template's Issues

Add wiki doc for `rails-template`

The generator will hang

generatemethod will hang if don't stop spring.
before using generate, we should add run "spring stop"
etc:

  run "spring stop"
  generate "clearance:install"

有个拼写错误

composer.rb L45
say "Stop spring if exsit"

exsit 应该为 exists

Add bootstrap4 as the default ui framework

1. bootstrap 4 gem
2. simple_form for bootstrap 4

document: create postgres user

createdb -d postgres
shoud be
createuser -d postgres

the default size of the database connection pool(5) should greater than threads num in puma(8~16).

https://devcenter.heroku.com/articles/concurrency-and-database-connections

Options misses the property 'exposes'

Got following error after fresh start:

Failed to compile.

./node_modules/jquery/dist/jquery.js (./node_modules/expose-loader/dist/cjs.js!./node_modules/jquery/dist/jquery.js)
Module build failed (from ./node_modules/expose-loader/dist/cjs.js):
ValidationError: Invalid options object. Expose Loader has been initialized using an options object that does not match the API schema.
 - options misses the property 'exposes'. Should be:
   non-empty string | object { globalName, moduleLocalName?, override? } | [non-empty string | object { globalName, moduleLocalName?, override? }, ...] (should not have fewer than 1 item)
    at validate (.../node_modules/schema-utils/dist/validate.js:96:11)
    at Object.loader (.../node_modules/expose-loader/dist/index.js:24:28)

Any idea on how to fix?

rename: Factory Girl -> Factory Bot

https://robots.thoughtbot.com/factory_bot

Add monit as process monitor

Could not find gem 'mina-puma (= 1.0.2)' ...

Could not find gem 'mina-puma (= 1.0.2)' in any of the gem sources listed in your Gemfile or available on this machine.

应该写错了。

`open_http': 503 Connection timed out (OpenURI::HTTPError)

remove config/application.yml.example
/Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:359:in open_http': 503 Connection timed out (OpenURI::HTTPError) from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:737:in buffer_open'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:212:in block in open_loop' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:210:in catch'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:210:in open_loop' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:151:in open_uri'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:717:in open' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/open-uri.rb:35:in open'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/actions/file_manipulation.rb:82:in get' from https://raw.github.com/80percent/rails-template/master/composer.rb:16:in get_remote'
from https://raw.github.com/80percent/rails-template/master/composer.rb:39:in apply' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/actions.rb:224:in instance_eval'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/actions.rb:224:in apply' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/railties-5.0.0.1/lib/rails/generators/app_base.rb:158:in apply_rails_template'
from (eval):1:in apply_rails_template' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/command.rb:27:in run'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/invocation.rb:126:in invoke_command' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/invocation.rb:133:in block in invoke_all'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/invocation.rb:133:in each' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/invocation.rb:133:in map'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/invocation.rb:133:in invoke_all' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/group.rb:232:in dispatch'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/thor-0.19.4/lib/thor/base.rb:444:in start' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/railties-5.0.0.1/lib/rails/commands/application.rb:17:in <top (required)>'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:68:in require' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:68:in require'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/railties-5.0.0.1/lib/rails/cli.rb:14:in <top (required)>' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:68:in require'
from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:68:in require' from /Users/rina.liu/.rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/railties-5.0.0.1/exe/rails:9:in <top (required)>'
from /Users/rina.liu/.rbenv/versions/2.3.1/bin/rails:23:in load' from /Users/rina.liu/.rbenv/versions/2.3.1/bin/rails:23:in

'

Improve production log tags

Before:

request_id

Now

request_id, remote_ip, session_id

Refine puma config & deploy

add rack-mini-profiler

Why used postgresql as default database? Is it must?

bootstrap3 depend on jquery but rails 5.1 remove it

add simple_form

Connection refused

rails-template/composer.rb

Line 20 in 238023d

repo = 'https://raw.github.com/dao42/rails-template/master/files/'

https://raw.github.com/dao42/rails-template/master/composer.rb
need change to
https://raw.githubusercontent.com/dao42/rails-template/master/composer.rb

Mina upgrade to 1.0

Consider to add `thoughtbot/clearance`

CarrierWave - whitelist did not work.

Please rename extension_white_list -> extension_whitelist

ref: Securing uploads

Update to bootstrap 4