README.md

Reindeer Hunt Console

Setup

Prerequisites

• Correct Ruby and Rails installed
• Yarn package manager
• Git LFS installed, hooks installed for this repo (git lfs install in your user account)

Follow the Rails Setup Snippet steps.

Fast setup

bundle
yarn

Create a .env file and set the following environment variables:

export RACK_ENV=development
export PORT=3000
export JDBC_DATABSE_URL=<databse url for local machine's development database>

This file should be loaded on launch by dotenv-rails

Create config/master.key and place the original private key that was generated upon the app's creation.

Debugging

In order to be able to use launch configurations to debug, the recommended extensions should be installed, and the ruby-debug-ide extension will also be needed:

gem install ruby-debug-ide rufo rubocop solargraph

Heroku Setup

This application is currently set up to run on Heroku for its production environment.

The following setup is needed:

• Installed Redis To Go add-on.
  • Configured REDIS_URL config var to the REDISTOGO_URL var
• Installed Heroku Postgres add-on (should be installed by default).
• Added the Heroku java buildpack. See also https://devcenter.heroku.com/articles/java-support#supported-java-versions, https://github.com/heroku/heroku-buildpack-jvm-common.
• Added the git LFS buildpack for Heroku, since Heroku doesn't natively support git LFS.
  • Configured HEROKU_BUILDPACK_GIT_LFS_REPO config var to https://<username>:<token>@gitlab.com/<group_name>/<repo name>.git

Environment variables that need setting: RACK_ENV (set by heroku) PORT: Set to the port to use when launching the server. Only needed if you're running the server with the heroku CLI locally, and even then defaults to 3000. See Procfile REDISTOGO_URL (redis server URL used in production for action cable) SECRET_KEY_BASE (not sure if this is needed or not, if it is created automatically or what) JDBC_DATABASE_URL: Needs to be the URL at which the database is accessible. Format: jdbc:postgres://<domain>:<port>/<database_name>?user=<username>&password=<password>. This is set automatically by the Heroku Java Buildpack. RAILS_MASTER_KEY=<private key for credentials.yml.enc> HEROKU_BUILDPACK_GIT_LFS_REPO=https://<username>:<token>@gitlab.com/<group_name>/<repo name>.git

Deployment

Since adding git LFS to this project, deployment to Heroku needs to be done a little differently:

git push heroku <branch> --no-verify

The no-verify flag tells git to skip pre-receive hooks, which would've caused the deployment to fail while it tried to push LFS assets.