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: 3 months 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 (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-01T14:02:11.000Z (4 months ago)
- Last Synced: 2025-06-01T23:16:40.951Z (4 months ago)
- Topics: api, boilerplate, boilerplates, flowbite, oauth2, rails7, ruby, tailwindcss, vitejs
- Language: Ruby
- Homepage:
- Size: 2.51 MB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Boilerplate
Create a sass app using rails 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 `simplecov`.
- 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.
## Getting started
I have being using this boilerplate on a Mac with ARM proccessor and Docker to get postgres db running. So here's the steps to get it up running.
- Make sure you have postgres running, I do it running docker like: `docker run --name postgres -e POSTGRES_USER=pedro -e POSTGRES_PASSWORD=password -v postgres:/var/lib/postgresql/data -p 5432:5432 -d postgres`
- Go to the `bin/setup` file and change the `APP_NAME` var to the name you desire, ex: `sample_project`
- On your terminal run the `bin/setup` script
- On your terminal run the `bin/dev` script
- Visit `http:localhost:3000` and have some fun.