Mac OS
Installation
1. Fork repository to your account
2. Clone repo to local
$ git clone https://github.com/<your-name>/miru-web.git
3. Install rvm and nvm
(Tip: To allow nvm to automatically detect and change node versions for
your project as you cd into the directory follow
this)
4. Install ruby 3.2.4
$ rvm install $(cat .ruby-version)
5. Install Node 18.4.2(can be skipped if you followed the tip mentioned in (3) above)
$ nvm install $(cat .nvmrc)
6. Install Postgres
$ brew install postgresql
7. Install elasticsearch
$ brew install elastic/tap/elasticsearch-full
$ brew services start elasticsearch-full
To run elasticsearch on latest macos(ventura) please follow the below instructions
- Install Docker Desktop ( M1 / Intel ) https://www.docker.com/products/docker-desktop/
- Run below command in your terminal & you can check by opening
localhost:9200
$ docker run -dp 127.0.0.1:9200:9200 -p 127.0.0.1:9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.17.7
- Install Chrome Extension to browse the Cluster ( Kind of like PGAdmin for Elastic Search ) https://chrome.google.com/webstore/search/multi%20elastic%20search%20head
- More information available at https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html
8. Install Redis
$ brew install redis
9. Setup the app
# Go to the miru-web app directory
$ bin/setup
10. Run app in local env
$ foreman start -f Procfile.dev
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
| Role | Password | |
|---|---|---|
| Owner | vipul@example.com | welcome |
| Admin | supriya@example.com | welcome |
| Employee | sam@example.com | welcome |
| Client | oliver@example.com | welcome |