YYC³ 开发者文档 · README

YYC³ 开发者文档套

面向开发者的完整技术文档。配套用户向导见项目 README,文档中心主索引见 docs/README.md

文档 内容
01 · 快速上手 环境要求、安装、启动、常见问题
02 · 可视化架构体系 系统分层 / 混合路由 / 数据流 / AI 链路 / 目录拓扑 / 徽章评估流水线(Mermaid 八图)
03 · 数据模型 SQLite 九张表、JSON 列约定、种子数据、迁移与备份
04 · API 参考 全部 REST 端点:请求/响应/错误码约定
05 · 前端组件体系 目录组织、UI 基建(shadcn/Radix)、状态管理、主题与角色系统
06 · AI 引擎与安全 服务端代理模式、密钥管理、AI 引擎模块清单
07 · 测试与质量门禁 tsc/lint/test/audit 四道门禁与债务清单
08 · 部署 本地生产、脚本、Docker 注意事项
09 · 贡献指南 分支模型、提交规范、徽章系统扩展指南(4 等级 × 8 分类)

一分钟导览

bun install --registry https://registry.npmmirror.com
cp .env.example .env.local   # 填入 BIGMODEL_API_KEY
bun run dev                   # http://localhost:1228
bun test                      # 216 个用例

技术栈速览

Next.js 16(App Router · Turbopack)· React 19 · TypeScript 5.9(strict)· Tailwind CSS 4 · shadcn/ui(Radix)· Redux Toolkit + TanStack Query · node:sqlite · next-intl v4 · Bun(测试运行时)