BiliNote 开源项目使用教程

1. 项目的目录结构及介绍

BiliNote 项目是一个开源的 AI 视频笔记助手，下面是项目的目录结构及各部分的简要介绍：

• BillNote_frontend: 前端代码目录，使用 Vite + React 进行构建。
• backend: 后端代码目录，基于 FastAPI 框架。
• doc: 项目文档存放目录。
• .env.example: 环境变量配置文件示例。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目使用的 MIT 许可证。
• README.md: 项目说明文件。
• docker-compose.yml: Docker 部署配置文件。

2. 项目的启动文件介绍

项目的启动主要涉及前端和后端两个部分：

• 后端启动: 进入 backend 目录，使用以下命令安装依赖并启动服务：

  cd backend
  pip install -r requirements.txt
  uvicorn app.main:app --reload
  

  这将启动 FastAPI 服务，默认端口为 8000。

• 前端启动: 进入 BiliNote_frontend 目录，使用以下命令安装依赖并启动开发服务器：

  cd BiliNote_frontend
  pnpm install
  pnpm dev
  

  前端默认开发服务器端口为 5173。

启动后，你可以通过浏览器访问 http://localhost:5173 来查看前端界面。

3. 项目的配置文件介绍

项目的配置文件是 .env 文件，以下是一些基本的环境变量配置：

• API_BASE_URL: 后端 API 的基础 URL。
• OUT_DIR: 输出笔记的目录。
• IMAGE_BASE_URL: 图片存储的基础 URL。
• MODEL_PROVIDER: 使用的 AI 模型提供者（如 OpenAI、DeepSeek、Qwen）。
• OPENAI_API_KEY: OpenAI API 的密钥。
• DEEP_SEEK_API_KEY: DeepSeek API 的密钥。
• QWEN_API_KEY: Qwen API 的密钥。

.env.example 文件提供了一个配置的示例，你需要在项目根目录下创建一个 .env 文件，并根据实际情况进行配置。

以上就是 BiliNote 开源项目的目录结构、启动文件和配置文件的介绍。希望这个教程能够帮助你更好地理解和使用这个项目。