Notes Agent（暂命名） 团队开发说明
本文件用于团队开发期间快速配置环境和启动项目，不是正式的项目 README。
当前目录
NotesAgent/
├── frontend/ Vue 3 + TypeScript + Vite 前端
├── backend/ FastAPI + Pydantic 后端
├── docs/ 分工与技术栈说明
└── server sync/ 云同步服务预留目录，当前未实现
开发环境
当前前后端壳子需要：
| 环境 | 要求 | 说明 |
|---|---|---|
| Git | 较新稳定版 | 代码版本管理 |
| Node.js | 22 或更高版本 | 推荐使用 Node.js 24 |
| pnpm | 10 或更高版本 | 前端依赖与脚本管理 |
| Python | 3.11 或更高版本 | 推荐使用 Python 3.12 |
| uv | 较新稳定版 | 后端依赖和虚拟环境管理 |
检查本机环境：
git --version
node --version
pnpm --version
python --version
uv --version
当前壳子暂不需要 Rust 和 Tauri。开始桌面端集成后，再按照 docs/AI笔记软件技术栈说明-团队版-v2.2.md 安装 Rust Toolchain 与 Tauri CLI。
首次初始化
后端
cd backend
uv sync
cd ..
uv sync 会根据 backend/pyproject.toml 安装依赖，并自动创建和管理 backend/.venv，不需要手动创建或激活虚拟环境。
前端
cd frontend
pnpm install
cd ..
启动开发环境
前端和后端需要在两个终端中分别启动。
终端一：启动后端
cd backend
uv run uvicorn app.main:app --reload --host 127.0.0.1 --port 8000
后端地址：
- 健康检查：http://127.0.0.1:8000/health
- 服务状态：http://127.0.0.1:8000/api/status
- API 文档：http://127.0.0.1:8000/docs
- OpenAPI JSON：http://127.0.0.1:8000/openapi.json
开发环境使用外部模型
当前仓库尚未包含 Tauri Host 与 Stronghold。需要联调外部模型时，应在启动后端的同一个终端会话中，通过进程环境注入密钥，再启动 AI Core：
- DeepSeek 预设的 Credential ID 为
deepseek，开发环境读取DEEPSEEK_API_KEY，也兼容 Host 约定的AINOTE_CREDENTIAL_DEEPSEEK； - OpenAI 预设的 Credential ID 为
openai，开发环境读取OPENAI_API_KEY，也兼容AINOTE_CREDENTIAL_OPENAI。
PowerShell 7 中可以在启动后端的同一终端安全输入 DeepSeek Key，输入内容不会回显，也不会进入命令历史：
$env:DEEPSEEK_API_KEY = Read-Host "DeepSeek API Key" -MaskInput
cd backend
uv run uvicorn app.main:app --reload --host 127.0.0.1 --port 8000
环境变量只应配置在本机或当前进程中，不要写入仓库文件、README、Issue、提交信息或聊天记录。设置环境变量后必须重新启动后端进程，已经运行的进程无法读取之后才添加的变量。前端 Provider 表单中的 Credential ID 不是 API Key，不能把密钥明文粘贴到该字段。
终端二：启动前端
cd frontend
pnpm dev
开发环境中，Vite 会将 /api 和 /health 请求代理到 http://127.0.0.1:8000。联调时应先启动后端，再启动或刷新前端。
测试与构建
后端测试：
cd backend
uv run pytest
前端类型检查及生产构建：
cd frontend
pnpm build
构建产物位于 frontend/dist，该目录不提交到 Git。
日常开发注意事项
- Python 依赖统一修改
backend/pyproject.toml，修改后执行uv sync。 - 前端依赖统一使用 pnpm 安装，不要混用 npm 或 yarn。
backend/.venv、frontend/node_modules、frontend/dist均为本地生成目录，不提交到 Git。- API 默认监听
127.0.0.1:8000，前端默认监听127.0.0.1:5173。 - 后端附件目录默认是
backend/data/attachments，可通过APP_ATTACHMENTS_PATH覆盖；该目录由桌面 Host 管理。 - 跨模块接口发生变化时，需要同步更新前后端类型和
docs中的接口说明。 - 当前前后端接口清单见
docs/后端接口契约-开发版.md，OpenAPI 以/openapi.json为准。 - 前端页面、交互、状态管理和第一阶段验收要求见
docs/前端页面需求说明-开发版.md。 - 分支、提交、Pull Request、Review 和冲突处理规范见
docs/Git使用细则-团队开发版.md。