---
slug: "unirhy"
source_type: "readme"
source_url: "https://cdn.jsdelivr.net/gh/coooolfan/unirhy@main/README.md"
repo: "https://github.com/coooolfan/unirhy"
source_file: "README.md"
branch: "main"
---
# <img src="docs/logo.svg" alt="UniRhy Logo" width="32" valign="middle" /> UniRhy

UniRhy is a self-hosted music streaming platform organized as a monorepo with separated backend, frontend, and website projects. It aims to provide deployable and extensible music library management, playback, and synchronization capabilities.

English | [简体中文](https://github.com/coooolfan/unirhy/blob/HEAD/docs/README.zh-CN.md)

> [!NOTE]
> This project is still in a very early stage. Feedback and contributions of all kinds are welcome, and existing features may still change significantly.

## Screenshots

<table align="center">
  <tr>
    <td><img src="docs/screenshots/home-playing-mobile.webp" alt="Home page on mobile" height="330" /></td>
    <td><img src="docs/screenshots/home-playing-desktop.webp" alt="Home page on desktop" height="330" /></td>
  </tr>
</table>

<sub>All album covers shown are public domain (CC0 / Public Domain Mark) artworks from The Met Open Access and Internet Archive netlabels. Album, artist, and track names are fictional demo data.</sub>

## Features

- Self-hosted deployment with no external service dependency.
- Music resource management.
- Cross-platform clients for Web, macOS, Android, iOS, and Windows.
- Playback state synchronization.
- Plugin-based extension support.

## Project Structure

- `server/`: Backend service based on Spring Boot, Kotlin, Gradle, and Jimmer ORM.
- `web/`: Main frontend client based on Vue, TypeScript, Vite, Pinia, and Tailwind CSS, including Tauri 2 desktop configuration.
- `website/`: Project website based on Vue, TypeScript, and Vite.
- `docker/`: Containerization files.
- `docs/`: Project-level supplementary documentation, including release notes under `docs/release_notes/`.

## Requirements

- JDK 25
- Node.js 24
- Yarn 4.12+
- PostgreSQL

## Quick Start

### Backend

```sh
cd server
./gradlew bootRun
```

### Frontend Client

```sh
cd web
yarn
yarn dev
```

### Website

```sh
cd website
yarn
yarn dev
```

## Documentation

- [Terminology Dictionary](https://github.com/coooolfan/unirhy/blob/HEAD/docs/TERMINOLOGY.md)
- [Backend Testing Guide](https://github.com/coooolfan/unirhy/blob/HEAD/server/README/TESTING.md)
- [Playback Sync](https://github.com/coooolfan/unirhy/blob/HEAD/server/README/PLAYBACK_SYNC.md)
- [Backend Dependencies](https://github.com/coooolfan/unirhy/blob/HEAD/server/README/DEPENDENCIES.md)
- [Frontend Dependencies](https://github.com/coooolfan/unirhy/blob/HEAD/web/README/DEPENDENCIES.md)

## License

See [LICENSE](https://github.com/coooolfan/unirhy/tree/HEAD/LICENSE).