Mac Dev Setup Guide

If running the project locally, follow these instructions to get started:

Install Homebrew

If you don't already have it, install Homebrew. You can run the following command to do so:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Install Ruby

Find the required Ruby version here.

We recommend installing rbenv using Homebrew with the following commands:

brew install rbenv ruby-build
rbenv init

Follow the instructions in your shell.

Now, install a Ruby version:

rbenv install <required-ruby-version>

And finally, set this as your default Ruby version for your machine if desired:

rbenv global <required-ruby-version>

Check your Ruby version:

ruby -v

Install PostgreSQL

Install Postgres and start it as a service:

brew install postgresql

brew services start postgresql

Install other dependencies

The app uses ActiveStorage, which requires some 3rd party libraries to be installed on your system. For the app to work properly, you'll need libvips and Redis:

brew install vips redis

Start Redis as a service:

brew services start redis

If you do not have Redis running, bin/dev will start Rails but Sidekiq will fail to boot.

If you prefer not to run Redis as a background service, you can also start it manually in another terminal:

redis-server --port 6379

Setup user

On a fresh installation of Postgres, a user, postgres will be available. If this is not the case (due to a prior installation of PG or other reasons), you can create the user with the following command:

createuser -s postgres

Start the Project

Start by forking and then cloning the repo locally. Then run the following commands to start the app:

cd sure
cp .env.example .env
bundle install
bin/rails db:setup
bin/dev