www_site/README.md
2570050763@qq.com 631fce55b3 docs: 更新 README 至 V1 全阶段完成并上线的实际状态
- 修正过时的“TTS/CMS 未接入”描述,补充 Phase 0-5 状态表
- 新增架构拓扑、目录结构、路由速查与本地开发命令
- 补全文档索引(Phase 5 报告、生产部署记录、部署/运维/验收等)
2026-09-17 20:08:04 +08:00

5.9 KiB
Raw Blame History

考町科技官网暨 AI 工具平台

考町科技KAOTINGS公司官网 + AI 工具平台 V1。公司以蓝牙周边、音频及智能硬件为主业官网承担品牌展示、产品介绍和客户联系AI Lab 首个工具为文本转语音TTS提供从注册登录到生成、保存、回放、下载的完整闭环。

当前状态

V1 全部 5 个阶段已完成并上线生产(域名 www.kaotings.com,测试/生产服务器 192.168.199.22,发布目录 /home/flym/releases/,发布与回滚记录见 docs/production-deployment-*.md)。

阶段 内容 状态
Phase 0 现状审计(docs/AUDIT.mddocs/DECISIONS.md 完成
Phase 1 设计系统与官网骨架首页、产品、关于、联系、TTS/账户界面) 完成
Phase 2 用户认证与权益基础注册、登录、会话、Role/Plan、额度结构、验证抽象 完成
Phase 3 TTS 产品闭环(任务持久化、额度冻结/结算、Worker、私有音频、历史回放下载 完成
Phase 4 CMSPayload与业务管理后台用户/VIP/额度/TTS/审计) 完成
Phase 5 集成验收、异常矩阵、备份恢复、部署与回滚说明 完成

已上线能力要点:

  • 注册强制邮箱验证(腾讯企业邮 SMTP图形验证码防爆破短信验证阿里云号码认证 PNVS已实现、当前未启用配置见 docs/sms-verification.md
  • TTS 上游地址与 API Key 支持管理后台配置DB 优先于 env保存前探测任务采用幂等键 + 租约 + 超时恢复,结算保证额度不变式。
  • CMS 独立库独立管理员,产品 draft/published/unpublished 状态流,官网产品列表经 CMS_PUBLIC_API_URL 拉取已发布内容(未配置时回退本地占位数据,仅限开发)。
  • 已知阻断项:上游 TTS 服务仍走公网 HTTPdocs/phase-5-report.md §4需上游提供 HTTPS/来源限制后解除。

架构

浏览器
 └─ CaddyHTTPS :443:80 跳转)
     ├─ /api/*   → FastAPI 业务 API127.0.0.1:8000
     │                ├─ PostgreSQL 业务库 kaotings用户/会话/额度/TTS 任务)
     │                ├─ 进程内 asyncio Worker → 内部 TTS API → 私有音频目录
     │                └─ SMTP邮箱验证码/ 阿里云 PNVS短信未启用
     ├─ /cms/*   → Payload CMS127.0.0.1:3001独立库 kaotings_cms
     └─ 其余     → Next.js 官网127.0.0.1:3000
  • 前端Next.js 16 + React 19 + Tailwind CSS 4 + TypeScriptApp Router
  • 业务 APIFastAPI + psycopg 3 + Argon2id + httpxservices/api/app/main.py
  • 内容管理Payload CMSapps/cms
  • 部署Caddy 反代 + 3 个 systemd 服务(kaotings-web / kaotings-cms / kaotings-api+ 发布目录软链切换,见 infra/

目录结构

app/            官网页面(/、/products、/tts、/login、/register、/account、/admin/*
components/     共享组件导航、页脚、认证表单、账户面板、admin/* 管理界面)
lib/            内容适配器CMS 拉取/本地回退)、管理端 API 客户端
services/api/   FastAPI 业务 APIapp/ 代码、migrations/ 迁移、tests/ 故障注入测试)
apps/cms/       Payload CMS 应用collections/ 内容模型、migrations/
infra/          Caddy 配置、systemd 单元、运维脚本(备份、告警、上游探测)
assets/brand/   正式品牌素材(使用规则见 docs/ASSETS.md
docs/           规划、审计、契约、阶段报告、部署与运维文档

路由

路由 页面 访问要求
//products/products/[slug]/about/contact 官网公开页 公开
/tts TTS 工作台(生成/历史/回放/下载) 浏览公开,生成与历史须登录
/login/register/account 认证与账户中心 未登录 / 当前用户
/admin/admin/users/admin/tts 业务管理后台 role=admin
/cms/admin CMS 内容管理 受控 CMS 管理员

本地开发

# 官网
npm install
npm run dev        # http://localhost:3000
npm run typecheck
npm run build      # 生产构建;生产环境需设 CMS_PUBLIC_API_URL

# 业务 API
cd services/api
pip install -r requirements.txt
cp .env.example .env   # 配置 DATABASE_URL、CSRF_SECRET 等
python -m app.migrate  # 执行 migrations/
# 受控初始化管理员(凭据只从进程环境变量注入,不覆盖已存在账户):
#   ADMIN_EMAIL=... ADMIN_PASSWORD=... python -m app.init_admin
uvicorn app.main:app --host 127.0.0.1 --port 8000

# CMS独立应用默认端口 3001
cd apps/cms
npm install
npm run dev

生产部署、发布/回滚流程见 docs/DEPLOYMENT.md,音频/数据库备份恢复与告警见 docs/OPERATIONS.md

文档索引