README.md

Fdbk

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

Deployment

This project is pre-configured to be (easily) deployed to Heroku servers, but needs you to have the Potassium binary installed. If you don't, then run:

$ gem install potassium

Then, make sure you are logged in to the Heroku account where you want to create the app and run

$ potassium install heroku --force

this will create the app on heroku, create a pipeline and link the app to the pipeline.

You'll still have to manually log in to the heroku dahsboard, go to the new pipeline and 'configure automatic deploys' using Github You can run the following command to open the dashboard in the pipeline page

$ heroku pipelines:open

Remember to connect each stage to the corresponding branch:

1. Staging -> Master
2. Production -> Production

That's it. You should already have a running app and each time you push to the corresponding branch, the system will (hopefully) update accordingly.

Continuous Integrations

The project is setup to run tests in CircleCI

You can also run the test locally simulating the production environment using CircleCI's method.

Style Guides

Style guides are enforced through a CircleCI job with reviewdog as a reporter, using per-project dependencies and style configurations. Please note that this reviewdog implementation requires a GitHub user token to comment on pull requests. A token can be generated here, and it should have at least the repo option checked. The included config.yml assumes your CircleCI organization has a context named org-global with the required token under the environment variable REVIEWDOG_GITHUB_API_TOKEN.

The project comes bundled with configuration files available in this repository.

Linting dependencies like rubocop or rubocop-rspec must be locked in your Gemfile. Similarly, packages like eslint or eslint-plugin-vue must be locked in your package.json.

You can add or modify rules by editing the .rubocop.yml, .eslintrc.json or .stylelintrc.json files.

You can (and should) use linter integrations for your text editor of choice, using the project's configuration.

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

Authorization

For defining which parts of the system each user has access to, we have chosen to include the Pundit gem, by Elabs.

Authentication

We are using the great Devise library by PlataformaTec

Administration

This project uses Active Admin which is a Ruby on Rails framework for creating elegant backends for website administration.

This project supports Vue inside ActiveAdmin

• The main package is located in app/javascript/active_admin.js, here you will declare the components you want to include in your ActiveAdmin views as you would in a normal Vue App.
• Additionally, to be able to use Vue components as Arbre Nodes the component names are also declared in config/initializers/active_admin.rb
• The generator includes an example component called admin_component, you can use this component inside any ActiveAdmin view by just writing admin_component as you would with any html tag.
  • For example:

    admin_component(class:"myCustomClass",id:"myCustomId") do
      admin_component(id:"otherCustomId")
    end
    

  • (Keep in mind that the example works with ruby blocks because AdminComponent has a <slot> tag defined, therefore children can be added to the component)
• The integration supports passing props to the components and converts them to their corresponing javascript objects.
  • For example, the following works

  admin_component(testList:[1,2,3,4],testObject:{"name":"Vue component"})
  

  • You can also use any vue bindings such as v-for , :key etc.

It uses the ActiveAdmin's Pundit adapter.

• Policies for admin resources must inherit from BackOffice::DefaultPolicy and be placed inside the app/policies/back_office directory.

  • For example:

    app/admin/clients.rb:

    ActiveAdmin.register Client do
      # ...
    end

    app/policies/back_office/client_policy.rb:

    class BackOffice::ClientPolicy < BackOffice::DefaultPolicy
    end

File Storage

For managing uploads, this project uses Shrine. When generated, this project includes the following files and configurations:

• ImageUploader that includes file type validation

• CoverImageUploader, inheriting from ImageUploader. It does a couple of things:

  • Generates derivatives in jpg and webp format, for three different sizes. For an attachment of name image, to get the url for a derivative, let's say sm, you would do record.image_url(:sm)
  • Saves a blurhash code to the attachment metadata

• ImageHandlingUtilities, a shrine plugin in the initializers folder that is used in the CoverImageUploader. Given a model with an attachment of name image, it adds the following methods to the model:

  • image_blurhash: returns blurhash from metadata
  • generate_image_derivatives: It generates all derivatives defined in Uploader. If file already had derivatives, it replaces them with newly generated ones. Associated class method: generate_all_image_derivatives
  • generate_image_metadata: refreshes all metadata for attachment. Associated class method: generate_all_image_metadata
  • generate_image_derivatives_and_metadata: does both previous things. Useful because it does so opening the file only once. Associated class method: generate_all_image_derivatives_and_metadata

  Class methods are the same as their instance counterparts, but for collections. They also allow error handling on an individual record by passing a block to handle each error. If no block is given, attachments that throw errors are ignored and the iteration continues

• ImageHandlingAttributes serializer concern. It adds a method add_image_handling_attributes to all serializers that inherit from BaseSerializer. Considering an attachment of name image, this method adds two attributes to the serialized record:

  • image_blurhash
  • image. This is a hash that includes urls for all derivatives passed to the method. For example:

    add_image_handling_attributes(attachment_name: :image, derivatives: [:sm, :md], include_original_image: true)
  
    # results in the following hash for the image attribute:
    # {
    #   sm: { url: 'someurl.com/bla' },
    #   md: { url: 'someurl.com/ble' },
    #   original: { url: 'someurl.com/ble' }
    # }
  

• SHRINE_SECRET_KEY environment variable. It comes witha value set in .env.development, but you'll need to set one for it in staging and production. It can be any random value, generating it with SecureRandom.hex for instance

Rails pattern enforcing types

This project 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

API Support

This projects uses Power API. It's a Rails engine that gathers a set of gems and configurations designed to build incredible REST APIs.

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.

Development

For hot-reloading and fast webpacker compilation you need to run webpack's dev server along with the rails server:

$ ./bin/webpacker-dev-server

Running the dev server will also solve problems with the cache not refreshing between changes and provide better error messages if something fails to compile.

For even faster in-place component refreshing (with no page reloads), you can enable Hot Module Reloading in config/webpacker.yml

development:
  dev_server:
    hmr: true