alex-benoit / rails-template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README

Overview

Rails 6 template

Deployment

GitHub Actions to deploy the Rails application

Development

Setup

Prerequisites:

Setup steps:

git clone git@github.com:alex-benoit/rails-template.git
cd rails-template
bin/setup

Run the app

To run the app locally you may need to ask a colleague for the secrets to complete the following file:

  • .env.development.local

Once you have this, start-up the app by running:

bundle exec rails s

Code structure & patterns

Interactors

API operations with complex business-logic are implemented with Interactors. Some simple API operations (e.g. 3-5 lines of code) remain inline within a controller.

Presenters

Complex API responses are generated with Presenters. These are typically plain Ruby classes which 'render' hashes or arrays, which the Controller marshals to JSON.

About


Languages

Language:Ruby 84.2%Language:HTML 9.8%Language:JavaScript 5.1%Language:Dockerfile 0.5%Language:Shell 0.2%Language:SCSS 0.1%