PPAgent 文档

Appearance

以代码运行 ​

本文档提供了如何通过代码安装和使用本项目的详细说明。

获取项目代码 ​

首先，从GitHub仓库克隆项目代码：

bash
git clone https://github.com/ppagent/sample.git
cd sample

设置FFMPEG下载地址 ​

在安装依赖之前，需要先设置ffmpeg-static的CDN下载地址，以加速下载过程。

Windows PowerShell环境 ​

在Windows PowerShell中执行：

powershell
$Env:FFMPEG_BINARIES_URL="https://cdn.npmmirror.com/binaries/ffmpeg-static"

Linux/macOS环境 ​

在Linux或macOS终端中执行：

bash
export FFMPEG_BINARIES_URL=https://cdn.npmmirror.com/binaries/ffmpeg-static

安装依赖 ​

本项目建议使用pnpm作为包管理工具。如果您尚未安装pnpm，可以通过npm安装：

bash
npm install -g pnpm

设置好FFMPEG下载地址后，安装项目依赖：

bash
pnpm install

重要提示

最新版的pnpm在install之后会默认阻止build脚本，因此当出现以下提示的时候，需要执行pnpm approve-builds并按提示选中所有build脚本进行编译。

pnpm提示

运行项目 ​

依赖安装完成后，可以通过以下命令启动项目：

  • dev模式启动（对应环境变量 .env.development）
bash
pnpm dev
  • prod模式启动（对应环境变量 .env）
bash
pnpm build
pnpm start

注意事项 ​

  • 确保您的开发环境满足项目的基本要求（Node.js版本不低于20）
  • 如果遇到ffmpeg相关下载问题，请确认CDN地址设置是否正确
  • 配置项的详细描述请参考.env文件配置。