README.zh-CN.md

Song2Quiz

English | 简体中文

一个先进的歌词分析和测验生成系统，利用AI提供对歌词的深度语义理解。

文档

完整文档请访问我们的 Mintlify 文档。

快速开始

1. 克隆仓库：

git clone https://github.com/technohippies/song2quiz.git
cd song2quiz

2. 创建并激活虚拟环境：

uv venv .venv
source .venv/bin/activate  # Mac 或 Linux
# 或
.venv\Scripts\activate     # Windows

3. 安装依赖：

uv pip install -r requirements.txt

4. 设置环境变量（复制 .env.example 到 .env 并填写你的密钥）：

cp .env.example .env
# 在.env中编辑以下API密钥：
# - GENIUS_API_KEY
# - OPENROUTER_API_KEY
# - LRCLIB_API_KEY
# - LANGFUSE_PUBLIC_KEY
# - LANGFUSE_SECRET_KEY
# - LANGFUSE_HOST

许可证

本项目采用 GNU Affero General Public License v3.0 许可证 - 详见 LICENSE 文件。