📋 开发流程指南

开发流程概览

1. 克隆项目 到本地
2. 下载依赖文件 - 从公共仓库下载 *.so 文件
3. 安装依赖 - 安装后端和前端依赖
4. 配置参数 - 配置数据库等参数
5. 启动后端 - 运行 FastAPI 服务
6. 启动前端 - 运行 Vite 开发服务器

---

步骤 1: 克隆项目

# 克隆项目到本地
git clone https://github.com/l429609201/misaka_danmu_server.git
cd misaka_danmu_server

步骤 2: 下载依赖文件

从 公共资源仓库 的 src/ 目录根据你测试平台的架构，选择性的下载两个 .so 文件，放到项目的 src/ 目录下：

# 从公共仓库下载以下文件：
# https://github.com/l429609201/Misaka-Scraper-Resources/tree/main/src
#
# 下载后放到项目的 src/ 目录：
# - src/rate_limiter.so
# - src/security_core..so

重要

这两个 .so 文件是必需的运行时依赖，缺少这些文件将无法正常启动服务。

步骤 3: 安装依赖

后端依赖 (Python)

# 使用 pip 安装
pip install -r requirements.txt

# 或使用 uv (推荐，更快)
uv pip install -r requirements.txt

前端依赖 (Node.js)

cd web
pnpm install

步骤 4: 配置参数

复制配置文件模板并修改：

# 创建配置目录
mkdir -p config

# 编辑配置文件 config/config.yml

配置文件示例（MySQL）：

database:
  type: mysql
  host: localhost
  port: 3306
  name: danmuapi
  user: root
  password: your_password

配置文件示例（PostgreSQL）：

database:
  type: postgresql
  host: localhost
  port: 5432
  name: danmuapi
  user: postgres
  password: your_password

注意

开发环境必须使用 MySQL 或 PostgreSQL 数据库，不支持 SQLite。

步骤 5: 启动后端

# 在项目根目录下启动后端
python src/main.py

步骤 6: 启动前端

# 进入前端目录
cd web

# 启动开发服务器
pnpm dev

前端启动后，访问 http://localhost:5173 即可看到开发界面。

---

提交代码

分支说明

分支	说明
main	稳定版本分支
dev	开发分支

提交规范

类型	说明
feat	新功能
fix	Bug 修复
docs	文档更新
refactor	代码重构

示例：

feat: 添加芒果TV弹幕源支持
fix: 修复弹幕获取失败的问题

---

提示

如果您不确定如何开始，可以先查看 Issues 中的问题。