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. Open your WSL terminal and Fork repository to your account.

2. Clone repo to local

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

3. Go to the project directory

cd miru-web

4. Install rvm

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

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 18.4.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 v18.4.2

8. Install Postgres

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. Install Elasticsearch

Using cURL, import Elasticsearch public GPG key into APT. Use -fsSL to silence progress and errors. Pipe output to gpg --dearmor for verification of downloaded packages.

curl -fsSL https://artifacts.elastic.co/GPG-KEY-elasticsearch | sudo gpg --dearmor -o /usr/share/keyrings/elastic.gpg

Next, add the Elastic source list to the apt index:

echo "deb [signed-by=/usr/share/keyrings/elastic.gpg] https://artifacts.elastic.co/packages/7.x/apt stable main" | sudo tee -a /etc/apt/sources.list.d/elastic-7.x.list

Next, update your package lists so APT will read the new Elastic source:

sudo apt update

Then install Elasticsearch with this command:

sudo apt install elasticsearch

Start the Elasticsearch service:

sudo service elasticsearch start

Ensure that the server is running:

sudo service elasticsearch status

10. Install Redis

Using cURL, import Redis public GPG key into APT. Use -fsSL to silence progress and errors. Pipe output to gpg --dearmor for verification of downloaded packages.

curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg

Next, add the Redis source list to the apt index:

echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list

Next, update your package lists so APT will read the new Elastic source:

sudo apt update

Then install Redis with this command:

sudo apt install redis

Start the Elasticsearch service:

sudo service redis-server start

Ensure that the server is running:

sudo service redis-server status

11. Setup the database user

Go to the database.yml file and update the default user and password with your postgres user and password.

If you haven't changed the default settings of postgres, then your postgres user and password will be "postgres".

12. Setup the app

$ bin/setup

13. Run app in local env

$ foreman start -f Procfile.dev

14. 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

Role	Email	Password
Owner	vipul@example.com	welcome
Admin	supriya@example.com	welcome
Employee	sam@example.com	welcome
Client	oliver@example.com	welcome