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

You will need a Ruby version >=3 to run this project. Ideally, the latest version.

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 3.3.0

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

rbenv global 3.3.0

Check your Ruby version:

ruby -v

Install Node.js

To handle JavaScript in the project, you'll need Node.js installed.

We recommend installing through NVM, which is similar to rbenv and allows you to manage Node versions. Install it with the following command:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

Verify your installation:

command -v nvm

Now install the latest version of Node and set it as the default:

nvm install node # "node" is an alias for the latest version

nvm alias default node

And verify your Node version:

node -v

Install Yarn

For Rails JS bundling and Webpacker, you'll need yarn, a package manager for the JS ecosystem:

npm install -g yarn

Install PostgreSQL

Install Postgres and start it as a service:

brew install postgresql

brew services start postgresql

Start the Project

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

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