Windows

Prerequisites

If you already have WSL installed on your Windows machine, then you can skip this step.

Install Windows Subsystem for Linux on your Windows machine.

Installation

1. Fork the repository and open WSL terminal

First, fork the repository to your GitHub account, then open your WSL terminal.

2. Clone repository to local machine

$ git clone https://github.com/<your-name>/miru-web.git

3. Go to the project directory

cd miru-web

4. Install RVM (Ruby Version Manager)

First, use the gpg command to contact a public key server and request the RVM project’s key which is used to sign each RVM release.

gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB

Next, install the gnupg2 package, as RVM’s installation script will use components of that to verify the release.

sudo apt-get install gnupg2

You’ll be prompted for your password, and you should enter the password you used for your Linux user when you installed Bash.

Next, use the curl command to download the RVM installation script from the project’s website.

curl -sSL https://get.rvm.io -o rvm.sh

Execute this command to install the latest stable release of RVM:

cat rvm.sh | bash -s stable

Execute this command to make rvm accessible in your current session:

source ~/.rvm/scripts/rvm

5. Install Ruby 4.0.1

Now use the rvm command to install the required version of Ruby:

rvm install $(cat .ruby-version)

You can check if ruby has been installed by running:

ruby -v

6. Install nvm

To install NVM on your Ubuntu machine:

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

This will install the nvm script to your user account. To use it, you must first source your .bashrc file:

source ~/.bashrc

7. Install Node 25.8.2

Now use the nvm command to install the required version of Node:

nvm install $(cat .nvmrc)

You can view the different versions you have installed by listing them:

nvm list

You can switch between installed versions with nvm use:

nvm use v25.8.2

8. Install PostgreSQL

Refresh your server’s local package index:

sudo apt update

Then, install the Postgres package:

sudo apt install postgresql

Now, you can start the server:

sudo service postgresql start

Ensure that the server is running:

sudo service postgresql status

9. Setup the app

$ bin/setup

10. Run app in local env

# Start all services
$ foreman start -f Procfile.dev

# Or run services individually:
$ bin/rails server                    # Rails server (port 3000)
$ bin/vite dev                        # Vite dev server
$ bundle exec rake solid_queue:start  # Background job processor (database-based)

11. Navigate to http://0.0.0.0:3000

To receive the emails in non-production apps.

Go to /sent_emails for accessing the emails(for /sent_emails route to work, add EMAIL_DELIVERY_METHOD='letter_opener_web' to .env)

Testing in staging environment

User Test credentials