melsheikh92 / miru-web

Miru | Time Tracking and Invoicing and Employee Benefits. Built using RubyonRails and ReactJS

Miru is an open-source tool, designed to make time tracking, invoice management, and accounting easy for small businesses worldwide. It is a platform for organizations to help them streamline their workflow.

---

Installation

1. Clone repo to local

git clone https://github.com/saeloun/miru-web.git

2. 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)

3. Install ruby 3.2.1

rvm install $(cat .ruby-version)

4. Install Node 16.4.2(can be skipped if you followed the tip mentioned in (2) above)

nvm install $(cat .nvmrc)

5. Install Postgres

brew install postgresql

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

7. Install Redis

brew install redis

8. Setup the app

# Go to the miru-web app directory

bin/setup

16. Run app in local env

foreman start -f Procfile.dev

17. 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)

Tests & Coverage

Tests

1. Run bin/rails db:create RAILS_ENV=test
2. Run bin/rails db:migrate RAILS_ENV=test
3. Run bundle exec rspec

Coverage

1. Run COVERAGE=true bundle exec rspec
2. Open coverage/index.html(open coverage/index.html in MacOS and xdg-open coverage/index.html in Debian/Ubuntu)

Testing in Review apps

User Test credentials

Role	Email	Password
Owner	[email protected]	welcome
Admin	[email protected]	welcome
Employee	[email protected]	welcome
Book keeper	[email protected]	welcome

Installation of Cypress Dependencies

Install the cypress dependencies using the following command:

cd cypress
yarn install

Running Cypress tests

Cypress tests can be run on local, staging and production environment.

To run the cypress tests on the local environment and in headless mode use the following command:

cd cypress
yarn run cy:run:dev

To run the tests on local environment and in chrome browser use the following command:

cd cypress
yarn run cy:open:dev

To run the tests on staging environment and in headless mode use the following command:

cd cypress
yarn run cy:run:staging

To run the tests on staging environment and in chrome browser use the following command

cd cypress
yarn run cy:open:staging

Configure Sentry:

To configure Sentry set the project's sentry dsn as value to SENTRY_DNS environment variable.

Community Support

• Feel free to join our Discord channel for support and questions.
• Subscribe our latest blog articles and tutorials.
• Discussions: Post your questions regarding Miru Web
• Twitter
• Documentation

Contributing

We encourage everyone to contribute to Miru Web! Check out Contributing Guide for guidelines about how to proceed..

Note: We are working on improving the documentation. So we had created a docusaurus app for documentation. Check out the Miru Docs Repo.

Contributors ✨

Thanks goes to all our contributors

License

Miru © 2023, Saeloun - Released under the MIT License.