lyroc/README.md

# Lyroc - Apple Music 歌词显示 | Apple Music Lyrics Display

[English](#english) | [中文](#chinese)

<a name="english"></a>
## English

Lyroc is an elegant macOS application that displays real-time lyrics for Apple Music. It provides a clean and beautiful interface for you to easily view lyrics of the currently playing song.

### Features

- 🎵 Real-time Apple Music lyrics display
- 🎨 Clean and beautiful user interface
- 🌍 Multi-language support
- 🖥️ Native macOS experience

### Tech Stack

- Frontend: Vue 3 + Vite
- Desktop: Electron
- Backend: Python + FastApi
- Internationalization: Vue I18n

### System Requirements

- macOS operating system
- Apple Music application

### Installation

#### From Release

1. Visit the [Releases](https://github.com/tomchen1991/lyroc/releases) page
2. Download the latest `.dmg` file
3. Double-click the downloaded file and drag the app to your Applications folder

#### From Source

1. Clone the repository
```bash
git clone https://github.com/tomchen1991/lyroc.git
cd lyroc
```

2. Configure backend virtual environment
```bash
cd backend
python -m venv venv
source venv/bin/activate  # on macOS/Linux
# OR for Windows:
# .\venv\Scripts\activate
pip install -r requirements.txt
```

3. Install frontend dependencies
```bash
cd frontend
npm install
npm run build
```

4. Install Electron app dependencies
```bash
cd ../electron-app
npm install
```

5. Build the application
```bash
npm run build
```

The built application can be found in the `electron-app/dist` directory.

### Usage

1. Launch Apple Music and play music
2. Open the Lyroc application
3. Lyrics will automatically display on screen

### Development

#### Backend Development
```bash
cd backend
python -m venv venv
source venv/bin/activate  # on macOS/Linux
# OR for Windows:
# .\venv\Scripts\activate
python main.py
```

#### Frontend Development

```bash
cd frontend
npm install
npm run dev
```

#### Electron Development

```bash
cd electron-app
npm install
npm start
```

### Contributing

Issues and Pull Requests are welcome! For more information about development schedule and guidelines, please check [DEVELOPMENT.md](DEVELOPMENT.md).

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

---

<a name="chinese"></a>
## 中文

Lyroc 是一个优雅的 macOS 应用程序，用于显示 Apple Music 的实时歌词。它提供了一个简洁美观的界面，让您能够轻松查看正在播放歌曲的歌词。

### 功能特点

- 🎵 实时显示 Apple Music 歌词
- 🎨 简洁美观的用户界面
- 🌍 多语言支持
- 🖥️ 原生 macOS 应用体验

### 技术栈

- 前端：Vue 3 + Vite
- 桌面端：Electron
- 后端：Python + FastApi
- 国际化：Vue I18n

### 系统要求

- macOS 操作系统
- Apple Music 应用

### 安装说明

#### 从发布版本安装

1. 访问 [Releases](https://github.com/tomchen1991/lyroc/releases) 页面
2. 下载最新版本的 `.dmg` 文件
3. 双击下载的文件，将应用拖到 Applications 文件夹

#### 从源码构建

1. 克隆仓库
```bash
git clone https://github.com/tomchen1991/lyroc.git
cd lyroc
```

2. 配置后端虚拟环境
```bash
cd backend
python -m venv venv
source venv/bin/activate  # 在 macOS/Linux 上
# 或者在 Windows 上：
# .\venv\Scripts\activate
pip install -r requirements.txt
```

3. 安装前端依赖
```bash
cd frontend
npm install
npm run build
```

4. 安装 Electron 应用依赖
```bash
cd ../electron-app
npm install
```

5. 构建应用
```bash
npm run build
```

构建完成后，可以在 `electron-app/dist` 目录下找到打包好的应用。

### 使用方法

1. 启动 Apple Music 并播放音乐
2. 打开 Lyroc 应用
3. 歌词将自动显示在屏幕上

### 开发

#### 后端开发
```bash
cd backend
python -m venv venv
source venv/bin/activate  # 在 macOS/Linux 上
# 或者在 Windows 上：
# .\venv\Scripts\activate
python main.py
```

#### 前端开发

```bash
cd frontend
npm install
npm run dev
```

#### Electron 开发

```bash
cd electron-app
npm install
npm start
```

### 贡献

欢迎提交 Issue 和 Pull Request！有关开发日程和指南的更多信息，请查看 [DEVELOPMENT.md](DEVELOPMENT.md)。

### 许可证

本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件