tuxianai.com 文档中心¶
欢迎使用 tuxianai.com —— 基于 FastAPI 的全栈工程(含 OSS storage 微服务、Redis 消息 Worker、用户前台 + 代理商/Admin 前端)。
快速入口¶
- 新手上手指南 — 第一次跑项目怎么开始
- 产品需求总览 — 全系统功能全景(测试/新手先看)
- 业务流程图集 — 跨模块端到端流程
- 更新日志 CHANGELOG — 近期显著功能变更
- 产品文档索引 — 测试需求 / 功能 / 设计 / 接口
- 架构总览 — 服务拓扑、端口、分层
服务端口(权威)¶
| 服务 | 端口 | 目录 |
|---|---|---|
| backend(主 API) | 8001 | src/backend/ |
| storage(OSS 微服务) | 8002 | src/storage/ |
| infinitecanvas(用户画布) | 5173 | src/infinitecanvas/ |
| agent-system(代理商) | 5174 | src/agent-system/ |
| admin-system(Canvas Admin) | 5175 | src/admin-system/ |
| chat(图现 Chat) | 5178 | src/chat/ |
| demo(C 端体验) | 5177 | src/demo/ |
端口以各应用
vite.config.ts/Settings.port为准。harness.yaml中myapp(8000)为历史残留。
产品文档(Admin / Canvas / Agent / Backend)¶
架构¶
- 架构总览
- 前端应用总览 — infinitecanvas / agent-system / admin-system / chat
- Infinite Canvas 前台 — 用户端路由、画布、生图 API
- Redis Stream 消息组件
- OSS 存储微服务
设计与归档¶
前端与部署¶
- 前端开发 Runbook — 启动端口、Vite 代理、CORS、门禁
- 部署指南 — Compose / K8s / K3s / ACK 对照
- K3s + Rancher Desktop — 本地全栈
- 阿里云 ACK — 云端全栈 + ACR + SLB
- Hermes / 图现 Chat(ACK)
- 会员计费 E2E · 计费运维流程
规范与运维¶
- 编码规范
- 测试规范
- Pre-commit 质量门禁手册 — 16 项 hook 详解 + 技术债治理
- 数据库迁移规范
- 质量门禁技术债 — 豁免清单 + 修复流程
- 支付服务 Runbook
- 自动运维 Runbook
- GitHub Actions 工作流
- ADR-0001:记录架构决策
本地预览¶
make docs-serve
# 或 poetry run mkdocs serve
访问 http://127.0.0.1:8003 查看文档站点(无需 Docker)。
如需 Docker 部署:make docs-up(需先启动 Docker Desktop)。