DEPRECATED: USE https://github.com/sumitngupta/rails-template

rails-template.rb

# DEPRECATED: USE https://github.com/sumitngupta/rails-template

# Rails Template for new applications

# This should get the developer all the way to the best logical point of generating "Business Logic". 
# (MVP) Target start to finish time is 30 minutes. 

# This is an opinionated rails template designed to get from zero to sane quick-start application 
# with Production-worth characteristics. This means that it should not require a lot of manual steps. 

# If this template requires major udpates everytime there are minor changes in the ecosystem, thats a bad sign. 

# Please read the entire template to understand all the steps. 
# Some high level concepts this is going to account for:
# - Launchable to a publically-available deployed environment like Heroku. Terraform might be the awesome solution here but might fall out of scope. 
# - Assumes a User.  Not sure if this is easy to do as an optional argument.  Authentication is common, this might be the strongest opinion. https://guides.rubyonrails.org/rails_application_templates.html#ask-question
# - This assumes making a "professional-level" app as a requirement so the setup for easy "Professional Characteristics" should be prioritized
#   * Websockets. Pusher has a free tier and might be the choice over the complexity of ActionCable, maybe maybe not
#   * Full testing capabilities. Default templates for shared testing? 
#   * Should be clear and easy how to generate a modern frontend interface through the backend. 
#   * React? GraphQL? Redux? 
#   * Open source Design System pre-installed.  Material?
#   * Code quality is paramount so linters with sane defaults

# Command to run: 
=begin
rails _6.0.0.beta1_ new PROJECTNAME \
  --skip-test \
  --webpack=react \
  --skip-turbolinks \
  --database=postgresql \
  --skip-coffee \
  -m https://gist.githubusercontent.com/sumitngupta/4ee72a44c6d08a45fc6d1a56fb9102cf/raw/601ad1752c497d6570ea0ace0bd2fdd024d0b202/rails-template.rb
=end

# Add Gems
gem 'foreman'
gem 'puma-heroku'

# Frontend Gems
gem 'autoprefixer-rails'
gem 'font_assets'
gem 'inky-rb', require: 'inky'
gem 'premailer-rails'

gem 'stenographer-rails'

group :development do
  gem 'bullet'
  gem 'lol_dba'
end

group :test do
  gem 'email_spec'
end

gem_group :development, :test do
  gem 'rspec-rails'
  gem 'rspec_junit_formatter'
  gem 'rspec-json_expectations'
  
  gem 'should_not'
  gem 'shoulda'
  gem 'shoulda-callback-matchers'
  gem 'shoulda-matchers'

  gem 'database_cleaner'
  
  gem 'factory_bot_rails'
  gem 'faker'
  gem 'fuubar'
  gem 'pry-rails'
  gem 'rails-controller-testing'
  gem 'simplecov', require: false
  gem 'spring'
  gem 'spring-commands-rspec'
end

bundle install

# Initialize Git Repo
after_bundle do
  git :init
  git add:    "."
  git commit: "-m 'Initial commit'"
end

=begin



Add standard Readme template

database_cleaner.rb
# frozen_string_literal: true

RSpec.configure do |config|
  config.before(:suite) do
    DatabaseCleaner.clean_with(:truncation)
  end

  config.before(:each) do
    DatabaseCleaner.strategy = :transaction
    Rails.cache.clear
  end

  config.before(:each) do
    DatabaseCleaner.start
  end

  config.after(:each) do
    Rails.cache.clear
    DatabaseCleaner.clean
  end
end



Install default rubocop configs

Switch to HAML

Install Inky https://github.com/zurb/inky-rb


## Ending to print at the end for manual instructions
### Clean Gemfile
* Alphabatize by groups
* Clean up duplication


=end

Next Targets -

• Complete Gem configuration list
• Finish whats commented out in the doc above
• Make it take URLs to configure Git and Heroku
• Copy in Readme
• Setup Database for local + production
• Install Rubocop --- automatically run corrections?
• Insure all gem installs are done
• Turn into a real repo for sharing
• Procfile (?)

• Websockets setup
• What Yarn packages are default?
• Install ESLint -- automatically run corrections?
• Opinionated frontend - GraphQL? JWT? React (duh), what other libraries?
• Enzyme, ESLint, Jest, faker, why-did-you-update

• Rake task to run all specs, frontend and backend.
• Should be able to run it and have them all pass

Email configuration

gem 'google-analytics-rails' - ask for GA key

Stenographer Install

CI / CD server -- continuous deployment would be sweet.

Standard "Home" Route? With signup and signin