Skip to content

Linux Dev Setup Guide

Zach Gollwitzer edited this page Feb 6, 2024 · 14 revisions

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

Note on Linux Distros

This guide is specifically for Ubuntu 22.04. If you are using another distro (other than Ubuntu) and cannot get the project started, please let us know in Discord so we can add instructions for it.

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:

sudo apt-get update

sudo apt-get install git-core zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev software-properties-common libffi-dev

sudo apt install rbenv

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 PostgreSQL

Install Postgres and start it as a service:

sudo apt install postgresql libpq-dev

sudo systemctl start postgresql

# (Optional) You can start automatically when your system boots with:
sudo systemctl enable 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

WIP Sidebar

Clone this wiki locally