LangBot 分为前端和后端,前端使用 Next.js + shadcn 开发,后端通过 Quart(Flask 的异步版本)开发。
代码位于 pkg 目录下,由根目录的 main.py 文件引导启动。
安装依赖,我们使用 uv 管理依赖。
pip install uv
uv sync --dev
启动后端
此时配置文件会自动生成到 data/config.yaml 文件中。
代码位于 web 目录下,需要安装 Node.js,pnpm。
复制 .env.example 到 .env。
安装依赖并启动前端
pnpm install
pnpm dev
# 若未安装pnpm,也可以使用npm来解决依赖并启动
npm install
npm run dev
然后根据输出信息,访问http://127.0.0.1:3000查看独立启动的前端页面。
生产环境中,前端会被预编译成静态文件,由后端提供服务,前端会自动访问同域的后端地址。
代码格式化
仓库中包含 lint 和 format 检查工作流,您推送代码后将被自动检查。请配置 pre-commit 来在提交时在本地提前检查代码。
uv run pre-commit install
API 文档
我们在开发每个接口之前都会先在 APIFox 中编写接口文档,请查看 API 文档。