https://github.com/opedrosouza/rails-sass-boilerplate

Rails SasS Boilerplate
https://github.com/opedrosouza/rails-sass-boilerplate

api boilerplate boilerplates flowbite oauth2 rails7 ruby tailwindcss vitejs

Last synced: 26 days ago
JSON representation

Rails SasS Boilerplate

• Host: GitHub
• URL: https://github.com/opedrosouza/rails-sass-boilerplate
• Owner: opedrosouza
• Created: 2023-03-03T19:34:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-18T13:13:16.000Z (about 1 month ago)
• Last Synced: 2024-11-20T14:50:06.291Z (about 1 month ago)
• Topics: api, boilerplate, boilerplates, flowbite, oauth2, rails7, ruby, tailwindcss, vitejs
• Language: Ruby
• Homepage:
• Size: 3.3 MB
• Stars: 9
• Watchers: 1
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Rails 7 Saas Boilerplate

Create a sass app using rails 7 really faster than normal.

## The motivation

Every time I had to start a new project I always had to install almost the same gems and have it configured. So the idea of this project is to have a starting point to build anything I need focusing only on the business rules and actual code instead of doing repetitive boring tasks.

## Implemented Features

- Authentication using `devise`.

- Authorization using `pundit`.

- Usage of Vite to handle assets/js/css files on the `frontend` folder.

- Usage of Flowbite/Tailwind to facilitate the implementation of beautiful components.

- Specs ready to go with `rspec`, `factory_bot`, `shoulda_matcher` and `capybara`.

- CI using github actions.

## The Big difference

This project has a few differences from a regular new Rails project the main ones are:

1. Usage of the `vite_rails` gem to handle css/js/images assets instead of the `sprockets`

   1. All js/css/images/etc files should be created inside the `app/frontend` folder. This way vite will process it accordingly.

   2. Vite also provides helpers to facilitate the usage of our assets on the app

2. It came with pre configured authentication and authorization for users and admins, which is being handled by devise/pundit.

3. It has specs configured and executed by rspec/factory_bot/capybara.

## Project Structure

The structure is pretty much the same as regular Rails MVC, the big difference is that we should store all our js/css/assets files inside `app/frontend` folder instead of the `app/assets` folder.

- Controllers

  - I've created 3 folders on the controllers to better organize the code:

    - admin folder must contain all the controllers related to admin side of the project

    - app folder must contain all the controllers that our logged_in users will use (this will be the actual app)

    - storefront folder must contain all controllers that can contain public pages, like the home page, the contact page or something like that.

  - The idea is that we can organize our code in a way which just taking a look we can see which that controller is being used.

- Frontend

  - This is where all our assets will leave, basically almost all js/css/images/etc will leave inside this folder to processed by vite.

The rest of the folders/structure is pretty much what the base rails gives to us.