跳转至

快速开始

本指南用于在本地完成最小可运行环境,并验证文档站点可正常构建。

1. 初始化依赖

uv venv
uv sync --all-groups

如果只运行主服务,可使用:

uv sync

2. 启动 AI 服务

在项目根目录执行:

uv run python main.py

服务默认监听 http://0.0.0.0:8000,健康检查端点为 GET /healthz

3. 预览文档站点

推荐使用 justfile 中统一入口:

just mkdocs-serve

等价命令为:

uv run mkdocs serve --dev-addr 127.0.0.1:8001

4. 启动 Demo 与 Admin 可选

一键启动:

just demo-up

手动启动:

cd demo-backend
uv run python app/main.py
cd demo-frontend
npm install
npm run dev
cd admin-frontend
npm install
npm run dev

5. 常见配置入口

  • 环境变量:根目录 .env.env.local
  • 非敏感配置:config.toml
  • 模型清单:ai_service/utils/models.json

配置细节见:docs/guides/configuration.md