Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eltonsantos/rails7-starter

Rails 7 starter default with Devise, RSpec and TailwindCSS
https://github.com/eltonsantos/rails7-starter

devise rails7 rspec tailwindcss

Last synced: 13 days ago
JSON representation

Rails 7 starter default with Devise, RSpec and TailwindCSS

Awesome Lists containing this project

README 

        




  Rails 7 starter with RSpec, Devise and Tailwind






  Generate the project   |   

  RSpec   |   

  Devise   |   

  Tailwind   




---







## 1. Generate the project



Get started the project using postgres as database, tailwind configured, esbuild to fast build javascript and skip test and jbuilder for doesn't create the folders and files referring. This project using `Ruby 3.2.2` and `Rails 7.0.4.3`.



```sh

rails new my_app --database=postgresql --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](https://github.com/rspec/rspec-rails).



Add the following to the Gemfile:



```ruby

group :development, :test do

  gem 'rspec-rails', '~> 6.0.0'

end

```



Next run the following commands:



```sh

$ rails generate rspec:install

$ bundle binstubs rspec-core

```



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



```sh

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.



```ruby

# 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`:



```ruby

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](https://github.com/heartcombo/devise).



Add the following to the Gemfile:



```ruby

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:



```sh

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:



```ruby

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



```sh

$ rails generate devise:install

$ rails generate devise User

```



#### Setting up letter opener



```ruby

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



```sh

$ rails generate devise:views

```



Go into the views and add additional fields.



#### Create a protected route and write a request spec for it



```sh

$ bin/rails g controller Pages home

$ bin/rails generate rspec:request pages

```



## 4. Tailwind



In Procfile.dev keep the file like this:



```

web: unset PORT && bin/rails server

js: yarn build --watch

css: yarn build:css --watch [debug,poll]

```

And install this two gems and after run bundle:



```sh

gem install rails_live_reload

gem install foreman



bundle

```



Following the Readme, Tailwind should already be configured and ready to use with the hot reload without having to reload the page, but for that you must start the server using the command



`bin/dev` 



##### the `rails s` command no longer needs to be used, as bin/dev is already responsible for using the foreman (to watch the changes) and starting the server 



## Author





  

  


  Elton Santos 🚀

  


  



 

    

  



  

    

  







Made with ❤️ by Elton Santos 👋🏽 [Contact me!](https://www.linkedin.com/in/eltonmelosantos/)