Edoctfad

Ruby on Rails application initialized with Hix on Rails.

System dependencies

• Ruby version: 2.7.0
• Rails version: 6.0.2.1
• Database: PostgreSQL

Configuration

Copy an existing sample environment file. Run:

$ cp .env.sample .env

and edit newly created .env file. The minimum you are going to need is your credentials for your local SQL database.

Then, install all the necessary gems:

bundle install

Database creation

In order to create the database with all the necessary seed data, run:

$ rails db:create db:schema:load db:seed

How to start the app

After completing all the steps above, start the project with:

rails server

How to run the test suite

First, copy (and optionally cusotmize) the RSpec configuration file:

cp .rspec.sample .rspec

In order to run the whole test suite, run:

$ bundle exec rspec

Code quality checks

The application provides the following code quality analysis tools:

• Brakeman
• Fasterer
• RuboCop with RuboCop RSpec, RuboCop Performance and RuboCop Rails
• Rails Best Practices
• Bundler Audit

To run them locally:

$ bundle exec brakeman
$ bundle exec fasterer
$ bundle exec rubocop
$ bundle exec rails_best_practices
$ bundle audit