Catfacts Mailer

This is a Ruby on Rails web application by Woet Flow that generates and mails daily catfacts.

This README documents whatever steps are necessary to get the application up and running.

Ruby version

Ruby 2.7.2

System dependencies

• Ruby
• Rails
• PostgreSQL
• Rspec
• Redis

Database creation (PostgreSQL)

Create database user 'name' with password

sudo -u postgres createuser -s name -P

Add database user password as an environment variable

echo 'export WOETFLOW_DEMO_CATFACTS_MAILER_DATABASE_PASSWORD="PostgreSQL_Role_Password"' >> ~/.bashrc

Export the variable for current session

source ~/.bashrc

Add user configuration to database.yml

...
default: &default
  adapter: postgresql
  encoding: unicode
  # For details on connection pooling, see Rails configuration guide
  # https://guides.rubyonrails.org/configuring.html#database-pooling
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: barry
  password: <%= ENV['WOETFLOW_DEMO_CATFACTS_MAILER_DATABASE_PASSWORD'] %>

development:
  <<: *default
  database: woetflow_demo_catfacts_mailer_development
...

Create databases from database.yml

rails db:create

Database initialization (PostgreSQL)

Restart database server

sudo service postgresql restart

How to run the test suite

Test if application is running

curl http://127.0.0.1:3000

Run all tests

rspec

Services

Check if redis-server is running

sudo service redis-server status

Force restart redis-server

sudo service redis-server restart

Stop/start redis-server

sudo service redis-server stop
sudo service redis-server start

Deployment instructions

Continuous Deployment enabled on main branch

Manually deploy application on Heroku

git push heroku main