README

This README would normally document whatever steps are necessary to get the application up and running.

How I start every rails app

• source: Rapid Ruby

1. Generate the project

rails new my_app --skip-jbuilder --skip-test --css=tailwind --javascript=esbuild

2. RSpec

To ensure these instructions are up to date, if anything goes wrong please reference the official documentation.

Add the following to the Gemfile:

group :development, :test do
  gem 'rspec-rails', '~> 6.0.0'
end

Next run the following commands:

$ rails generate rspec:install
$ bundle binstubs rspec-core

Add the following to config/application.rb to tweak the rails generators:

config.generators do |g|
  g.skip_routes true
  g.helper false
  g.assets false
  g.test_framework :rspec, fixture: false
  g.helper_specs false
  g.controller_specs false
  g.system_tests false
  g.view_specs false
end

# GZip all responses
config.middleware.use Rack::Deflater

Now we just have some configuration changes to make in the spec/rails_helper.rb file.

# Uncomment
Dir[Rails.root.join("spec", "support", "**", "*.rb")].sort.each { |f| require f }

# Then add these to the configuration block
config.fixture_path = "#{::Rails.root}/spec/fixtures"
config.global_fixtures = :all

config.include ActiveJob::TestHelper
config.include ActionMailbox::TestHelper
# config.include Devise::Test::IntegrationHelpers, type: :feature
# config.include Devise::Test::ControllerHelpers, type: :controller

Create this file in spec/support/request_spec_helper.rb:

module RequestSpecHelper
  include Warden::Test::Helpers

  def self.included(base)
    base.before(:each) { Warden.test_mode! }
    base.after(:each) { Warden.test_reset! }
  end

  def sign_in(resource)
    login_as(resource, scope: warden_scope(resource))
    resource
  end

  def sign_out(resource)
    logout(warden_scope(resource))
  end

  def json
    JSON.parse(response.body).with_indifferent_access
  end

  private

  def warden_scope(resource)
    resource.class.name.underscore.to_sym
  end
end

RSpec.configure do |config|
  config.include RequestSpecHelper, type: :request
  config.before(:each, type: :request) { host! "my_app.test" }
end

Now you can run your specs with bin/rspec.

3. Devise

To ensure these instructions are up to date, if anything goes wrong please reference the official documentation.

Add the following to the Gemfile:

gem "devise"
gem "letter_opener_web" # To easily see the emails devise sends in development

Add this to config/application.rb to configure devises layout:

config.to_prepare do
  Devise::SessionsController.layout "auth"
  # DeviseInvitable::RegistrationsController.layout "auth"
  # Devise::InvitationsController.layout "auth"
  Devise::RegistrationsController.layout "auth"
  Devise::ConfirmationsController.layout "auth"
  Devise::UnlocksController.layout "auth"
  Devise::PasswordsController.layout "auth"
  Devise::Mailer.layout "mailer"
end

Add these to app/controllers/application_controller.rb to protect all routes by default and allow some extra params:

before_action :configure_permitted_parameters, if: :devise_controller?
before_action :authenticate_user!

protected

def configure_permitted_parameters
  devise_parameter_sanitizer.permit(:sign_up, keys: %i[first_name last_name terms_and_conditions])
  devise_parameter_sanitizer.permit(:account_update, keys: %i[first_name last_name])
end

Generate the User model, and add two additional fields for first_name and last_name.

$ rails generate devise:install
$ rails generate devise User

Setting up letter opener

# append to `config/environments/development.rb`
config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
config.action_mailer.delivery_method = :letter_opener

Generate the devise views

This is so we can customise them and add our additional fields in.

$ rails generate devise:views

Go into the views and add additional fields.

Create a protected route and write a request spec for it

$ bin/rails g controller Pages home
$ bin/rails generate rspec:request pages

4. Tailwind UI layout for app / auth pages