Miru is an open-source, integrated platform designed for agencies, consultancies, and service businesses to manage their entire financial workflow. It consolidates time tracking, invoicing, expense management, payments, and reporting into a single product, eliminating the need for disparate tools and providing a unified view of project profitability and cash flow.

How It Works

Miru is built on a modern technology stack, featuring Ruby on Rails (upgraded to Rails 8 and Ruby 4.0.1 in version 3.0) for the backend and React with TypeScript for a refreshed, responsive frontend. The core approach is to offer a seamless, end-to-end workflow from time entry to payment processing. This includes intuitive time tracking, professional invoicing generated directly from tracked time, client and project management dashboards, and comprehensive reporting capabilities, all within one cohesive application.

Quick Start & Requirements

• Local Development: Install dependencies using mise exec -- bundle install. Refer to CLAUDE.md and docs/ for detailed local development setup. Requires Ruby 4.0.1 and Rails 8.
• Deployment: A Render Blueprint (render.yaml) is available for one-click infrastructure setup, provisioning a web service, worker service, PostgreSQL database, and Render Key Value instance. Deploy via https://render.com/deploy?repo=https://github.com/saeloun/miru-web/tree/production.
• Prerequisites: Frontend utilizes React and TypeScript.
• Documentation: Official documentation is available at docs.miru.so.

Highlighted Details

• Miru 3.0 features a significant upgrade with Rails 8 and Ruby 4.0.1, alongside a modernized React + TypeScript frontend and UI refresh.
• Includes a Render Blueprint for simplified one-click deployment to Render, streamlining infrastructure setup.
• Employs Playwright for end-to-end verification and release QA, ensuring robust testing.
• Offers seamless integration with Stripe for secure payment collection and automated locale maintenance via i18n-tasks.

Maintenance & Community

The project encourages contributions via a dedicated contributing guide. Community support and questions can be addressed through their Discord channel. Updates and tutorials are shared via blog articles. Saeloun stewards the project, with Vipul A M listed as the release owner for Miru 3.0. Links to discussions and Twitter are also provided.

Licensing & Compatibility

Miru is released under the MIT License. This permissive license allows for self-hosting and control, and is generally compatible with commercial use and closed-source linking.

Limitations & Caveats

The README indicates that documentation is actively being improved, suggesting it may be a developing area. No other significant limitations, such as alpha status or unsupported platforms, are explicitly mentioned.