Rails boilerplate - From Golden Owl Solutions

This is a Rails boilerplate use rails 7.2

Prerequisites

This project requires:

• Ruby (see .ruby-version), preferably managed using rbenv or asdf
• Node 20.9.0
• Yarn 1.x (classic)
• PostgreSQL must be installed and accepting connections

On macOS, these Homebrew packages are recommended:

  brew install rbenv
  brew install node 20.9.0
  brew install yarn
  brew install postgresql@16
  brew install redis

Getting started

Install - setup app

To setup a development environment (MacOS):

Clone the repo:

  git clone [email protected]:GoldenOwlAsia/rails-view-template.git

Install Ruby:

This project currently uses Ruby 3.3.0, which is most easily managed through a version manager like asdf, rbenv

Install Nodejs:

This project user Node 20.9.0, which is most easily managed through a version manager like asdf, rvm

Install Ruby gems:

• install bundle version 2.5.4 (or similar if you are using an older version on your development)

  gem install bundler -v 2.5.4

• bundle

  bundle install

Install Yarn.

  npm install -g yarn

Install Javascript Packages: Install packages:

  yarn

Set the RACK_ENV (optional): Later steps expect a RACK_ENV environment variable, so define one (usually 'development'.) This can be done by exporting a value in your shell config (by adding something like export RACK_ENV=development to your shell configuration file - .bashrc, etc)

Personalise the app settings:

• Copy config/database.yml.sample to config/database.yml and customise the values as needed.
• Copy .env.sample to .env and customise the values as needed.

Run server:

• rails server:

  rails s

• sidekiq

  bundle exec sidekiq

• Vite

  vite dev

Development

ERD

• Using gem: rails-mermaid_erd - Its auto generate when run rails db:migrate
• Can see ERD at http://localhost:3000/erd

FE references

• DaisyUI: https://daisyui.com/components/
• For icons: lucide icon packages: https://lucide.dev/icons/

Rspec

• Run test by:

    bundle exec rspec

• Check test coverage at coverage/index.html

ESLint

• ESLint check:

    yarn lint

• ESLint check & auto fix:

    yarn lint:fix

Config Git hooks manager

• Use lefthook gem: https://github.com/evilmartians/lefthook

    bundle exec lefthook install