Open-Source Operating System for Animal Health
A free, fully customizable Practice Information Management System
and the open platform that grows around it.
Built for the clinics that carry animal health, the families who depend on them,
and the developers extending both.
https://github.com/user-attachments/assets/a8b186be-bff6-4204-bfb4-4bd3e6e7c996
# Code Quality (SonarCloud)
| Metric | Backend | Platform (Frontend) | Mobile App | Desktop |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Quality Gate | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Backend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Frontend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_MobileAppYC) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Desktop) |
| Coverage | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Backend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Frontend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_MobileAppYC) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Desktop) |
| Bugs | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Backend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Frontend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_MobileAppYC) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Desktop) |
| Code Smells | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Backend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Frontend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_MobileAppYC) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Desktop) |
| Reliability | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Backend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Frontend) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_MobileAppYC) | [](https://sonarcloud.io/summary/new_code?id=yosemitecrew_Yosemite-Crew_Desktop) |
# Contents
- [Overview](#-overview)
- [Who It Is For](#-who-it-is-for)
- [Architecture](#-architecture)
- [Inside the Monorepo](#-inside-the-monorepo)
- [Installation](#-installation)
- [Our Tech Stack](#-our-tech-stack)
- [Engineering Quality](#-engineering-quality)
- [Documentation](#-documentation)
- [Dev Environment Access](#-dev-environment-access)
- [Join Our Growing Community](#-join-our-growing-community)
- [License](#-license)
# Overview
Yosemite Crew is an open-source operating system for the animal health industry. At its core is a free, fully customizable Practice Information Management System (PIMS) that unifies pet care operations, bringing together pet owners, pet businesses, and developers into one ecosystem.
Most veterinary software asks a clinic to bend around the vendor: rigid subscriptions, closed data, and a roadmap someone else owns. Yosemite Crew inverts that. The clinical record is yours, the schema is open, the integration surface speaks [FHIR R4](https://hl7.org/fhir/R4/), and the entire platform is yours to fork, extend, or run yourself.
It is one monorepo spanning four products: a web PIMS for clinics, a mobile app for pet parents, a desktop shell, and a developer platform.
# Who It Is For
### Pet Owners
**Ultimate convenience.** A mobile app to schedule appointments, hold virtual consultations, manage health records, and reach a library of care resources.
**Enhanced accessibility.** Whether in remote locations or facing mobility challenges, quality veterinary care stays reachable anytime, anywhere.
### Clinics & Providers
**Streamlined efficiency.** Scheduling and communication that cut administrative load instead of adding to it.
**Customization & integration.** Open source means no rigid subscription lock-in, and a system you can shape to how your practice actually works.
**Security & compliance.** Comprehensive data management, reporting, and adherence to regulatory standards.
**Scalability & support.** Built to grow with your practice, backed by regular updates and a community of contributors.
### Developers
**Empowering innovation.** A developer portal at the heart of an ecosystem that mirrors the versatility of the WordPress plugin model.
**Flexible environment.** Public APIs, documentation, and ready-to-use templates for building and managing plugins that extend the core.
**Community-driven growth.** A collaborative environment where contributors keep expanding what veterinary care software can do.
# Architecture
Four clients, one API, one source of truth. Every product in the repo speaks to the same Express service and the same Postgres schema.
```
…
```
**Postgres is the source of truth.** Prisma Migrate owns the schema, and tenant data is isolated by Postgres schema rather than by a filter column, so one clinic's records cannot leak into another's through a forgotten `WHERE`. See [ADR 0001](./docs/adr/0001-postgres-prisma-source-of-truth.md).
**FHIR R4 is a first-class surface,** not an export button. Clinical artifacts, tasks, templates, and rendered documents have FHIR-shaped routes, so an integrator can talk to Yosemite Crew in a vocabulary the wider health ecosystem already speaks.
# Inside the Monorepo
A pnpm + Turborepo workspace. Apps ship; packages are the shared spine underneath them.
### Apps
| App | What it is |
| ------------------ | ------------------------------------------------------------------------------------------------------- |
| `apps/frontend` | The web PIMS. Next.js 15, React 19, Zustand, Storybook, Playwright end-to-end and accessibility suites. |
| `apps/backend` | The API. Express 4 on TypeScript, Prisma, Socket.IO realtime, BullMQ workers, Stripe. |
| `apps/mobileAppYC` | The pet parent app. React Native 0.81, Redux, i18next localization, Detox end-to-end. |
| `apps/desktop` | The desktop shell. Electron, packaged by electron-builder, notarized, with auto-update. |
| `apps/dev-docs` | The developer documentation site. Docusaurus. |
### Packages
| Package | What it holds |
| ------------------------------ | ----------------------------------------------------------------------------- |
| `@yosemite-crew/database` | The Prisma schema and migrations. The schema source of truth. |
| `@yosemite-crew/auth` | Provider-independent session boundary built on SuperTokens. |
| `@yosemite-crew/types` | Shared domain and form types across web, mobile, and API. |
| `@yosemite-crew/fhir` | FHIR R4 helpers. |
| `@yosemite-crew/fhirtypes` | FHIR R4 resource type definitions. |
| `@yosemite-crew/design-tokens` | Semantic design tokens shared by web and mobile. Intent, not platform detail. |
| `@yosemite-crew/lib` | Cross-workspace utilities. |
# Installation
### Prerequisites
- Git
- Node.js 20 (see [`.nvmrc`](./.nvmrc))
- pnpm 8
### Steps
- Create a fork from Yosemite-Crew repository as it is described in GitHub docs. You can skip this step if you want to just run the project and not contribute.
- Clone your forked repository to your local machine using `git clone`. Clone dev branch if want to use the bleeding edge version.
```shell
git clone https://github.com/yourusername/Yosemite-Crew.git
git clone -b dev https://github.com/yourusername/Yosemite-Crew.git
cd Yosemite-Crew
```
- Install the project dependencies.
```shell
pnpm install
```
- Git hooks are installed automatically during `pnpm install` (Husky + commitlint + lint-staged + secret scanning).
- Configure environment variables for the API and web app. Each ships an example file to copy and fill in:
```shell
cp apps/backend/.env.example apps/backend/.env
cp apps/frontend/.env.example apps/frontend/.env
```
The backend needs a reachable PostgreSQL database on boot and Redis for the background job queues. [`apps/backend/README.md`](./apps/backend/README.md) documents the startup requirements.
- Run the website and api.
```shell
pnpm run dev --filter frontend -- Run the web app
pnpm run dev --filter backend -- Run the backend API
pnpm run dev -- To run website & api
```
- Run the Yosemite Crew mobile app. The mobile app does not load `.env` files. It needs its own configuration (a `variables.local.ts` and native Firebase and credential files copied from [`apps/mobileAppYC/config-templates/`](./apps/mobileAppYC/config-templates)). Follow the setup in [`apps/mobileAppYC/README.md`](./apps/mobileAppYC/README.md) before running.
```shell
// In apps/mobileAppYC directory
pnpm run start -- Start the metro server for mobile development
pnpm run android -- Run the app on Android
pnpm run ios --