Updateruby

This is a Rails application, initially generated using Potassium by Platanus.

Local installation

Assuming you've just cloned the repo, run this script to setup the project in your machine:

$ ./bin/setup

It assumes you have a machine equipped with Ruby, Node.js, Docker and make.

The script will do the following among other things:

• Install the dependecies
• Create a docker container for your database
• Prepare your database
• Adds heroku remotes

After the app setup is done you can run it with Heroku Local

$ heroku local

Continuous Integrations

The project is setup to run tests in CircleCI

You can also run the test locally simulating the production environment using docker. Just make sure you have docker installed and run:

bin/cibuild

Style Guides

The style guides are enforced through a self hosted version of Hound CI. The style configuration can also be used locally in development runing rubocop or just using the rubocop integration for your text editor of choice.

You can add custom rules to this project just adding them to the .ruby-style.yml file.

Sending Emails

The emails can be send through the gem send_grid_mailer using the sendgrid delivery method. All the action_mailer configuration can be found at config/mailer.rb, which is loaded only on production environments.

All emails should be sent using background jobs, by default we install sidekiq for that purpuse.

Testing in staging

If you add the EMAIL_RECIPIENTS= environmental variable, the emails will be intercepted and redirected to the email in the variable.

Internal dependencies

Authentication

We are using the great Devise library by PlataformaTec

Active Storage

For managing uploads, this project uses Active Storage.

Rails pattern enforcing types

This projects uses Power-Types to generate Services, Commands, Utils and Values.

Presentation Layer

This project uses Draper to add an object-oriented layer of presentation logic

Error Reporting

To report our errors we use Sentry

Scheduled Tasks

To schedule recurring work at particular times or dates, this project uses Sidekiq Scheduler

Queue System

For managing tasks in the background, this project uses Sidekiq

Seeds

To populate your database with initial data you can add, inside the /db/seeds.rb file, the code to generate only the necessary data to run the application. If you need to generate data with development purposes, you can customize the lib/fake_data_loader.rb module and then to run the rake load_fake_data task from your terminal.