Getting Started

Ruby and Environment Setup

This guide walks you through setting up a full Ruby on Rails environment to run this project locally.

---

🔧 Prerequisites

Before running the application, make sure the following tools are installed with the correct versions:

• Ruby: 3.4.1
• Rails: 7.2.2.1
• Node.js: 23.10.0
• npm: 10.9.2

You can use a version manager like rvm, asdf, or mise to install and manage these versions.

If your environment already has the correct versions installed, skip ahead to the ✅ Environment Checklist section.
Otherwise, follow the setup instructions below based on your operating system.

---

🍎 macOS Setup

If you're using macOS, follow this GoRails setup guide up to the PostgreSQL section:

https://gorails.com/setup/macos

Make sure to use the following versions:

mise use --global [email protected]
mise use --global [email protected]
gem install rails -v 7.2.2.1

---

💻 Windows Setup (via WSL2)

If you're on Windows, we recommend installing Ruby on Rails in a WSL (Ubuntu) environment:

https://gorails.com/setup/windows

Install Ubuntu (WSL2):

wsl --install -d Ubuntu

Launch into Linux:

wsl -d Ubuntu

Then follow the guide up to the PostgreSQL section, customizing versions as needed:

mise use --global [email protected]
mise use --global [email protected]
gem install rails -v 7.2.2.1

---

✅ Environment Checklist

Once installed, confirm everything is working:

$ ruby --version
ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +PRISM [x86_64-linux]

$ node -v
v23.10.0

$ rails -v
Rails 7.2.2.1

---

🚀 Clone and Run the Project

In your working directory:

git clone https://github.com/cs169/lamorinda-spirit-van.git
cd lamorinda-spirit-van

Install dependencies:

bundle install

Run the test suite to verify setup:

rspec
cucumber

If any JavaScript-based Cucumber scenarios fail due to browser automation (e.g. autocomplete features), you may need to install and configure ChromeDriver in your environment:

sudo apt install -y chromium-driver
which chromedriver
chromedriver --version

If all tests pass, you're ready to start developing! 🎉

---

For database setup, test commands, coverage viewing, and Heroku deployment instructions, see Development.
For secret key setup and environment variable configuration, refer to Environment Configuration.