From 928a8d0cf618bffcb64428c19b8ae6ad0bc69759 Mon Sep 17 00:00:00 2001 From: wikiboss Date: Sun, 20 Sep 2026 16:17:44 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E7=A1=AE=E7=AB=8B=E7=B3=BB=E7=BB=9F?= =?UTF-8?q?=E6=8A=80=E6=9C=AF=E9=80=89=E5=9E=8B=E4=B8=8E=E7=A0=94=E5=8F=91?= =?UTF-8?q?=E8=A7=84=E8=8C=83=E6=96=87=E6=A1=A3=20(Cool-Admin=20/=20Arco?= =?UTF-8?q?=20Design=20React=20/=20uni-app=20x)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 14 ++++++---- 2 files changed, 90 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index e69de29..6464117 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -0,0 +1,82 @@ +# OmniCard AI (CRMmp) - Agent & 开发者核心开发规范指引 + +> 本文档为 OmniCard AI 项目(全球智能数字名片 & 移动微官网 SaaS)的全局技术选型指南、架构规范与智能体 (Agent) 协作准则。所有开发协作与代码产出必须严格遵守本文档所列标准。 + +--- + +## 1. 项目基本概况 (Project Overview) + +- **项目名称**:OmniCard AI (全球智能数字名片 & 移动微官网 SaaS) +- **业务定位**:面向全球商务出海的下一代 **AI 驱动型智能名片 + 移动微官网 + 访客雷达 CRM + NFC 实体卡管理** 一体化平台。 +- **业务核心模块**: + 1. 微官网搭建与展示系统(Bento Grid 便当盒美学、响应式与 RTL 多语言适配) + 2. 访客雷达与轻量级出海 CRM(国家定位、停留轨迹、意向度评分、线索跟进) + 3. AI 智能中枢与数字人顾问(全天候接待客商、智能留资、多语言地道润色) + 4. NFC 实体卡硬件云端生命周期管理(场景切换、远程挂失) + 5. 企业团队管理与多租户商业化订阅体系 + +--- + +## 2. 核心技术选型 (Tech Stack) + +项目严格采用以下官方推荐的现代化技术栈,严禁脱离官方语法规范进行非标开发: + +| 端 / 层次 | 核心技术选型 | 官方文档与资源 | 规范要点 | +| :--- | :--- | :--- | :--- | +| **后端服务 (Backend API)** | **Cool-Admin (Node.js)** | [https://node.cool-admin.com/](https://node.cool-admin.com/) | 基于 Midway.js + TypeScript + TypeORM。严格遵循 Cool-Admin 模块化规范(Entity / Controller / Service / Middleware),充分利用其权限、定时任务与插件生态。 | +| **管理后台前端 (Admin Web)** | **React + Arco Design** | [https://arco.design/react/docs/start](https://arco.design/react/docs/start) | 字节跳动企业级设计系统。界面严格沿用 Arco Design 官方规范与组件(Table, Form, Card, Modal, Grid 等),杜绝重复造轮子。 | +| **用户端 (User Client)** | **uni-app x (App 端 + H5 端)** | [https://doc.dcloud.net.cn/uni-app-x/](https://doc.dcloud.net.cn/uni-app-x/) | DCloud 下一代原生强类型跨端框架。统一采用 uts 语言与 Vue 3 规范;一套源码兼顾原生 Android/iOS App 与 Web/H5 版本,优先使用内置原生组件与 uni-ui。 | + +--- + +## 3. 各端开发规范与准则 (Guidelines by Stack) + +### 3.1 后端:Cool-Admin (Node.js) 规范 +- **架构范式**:严格遵循 Midway.js 依赖注入 (IoC) 与模块化结构设计。所有业务按业务域拆分为独立 Module(如 `modules/card`, `modules/crm`, `modules/ai`)。 +- **实体与数据层 (TypeORM)**: + - 数据表字段使用下划线命名法,实体属性使用驼峰命名法。 + - 合理声明索引(尤其是多租户 `tenant_id`、访客追踪 `visitor_id`)。 + - 通用基类继承 `BaseEntity`,保持字段(创建时间、更新时间等)一致。 +- **服务与控制器**: + - Controller 保持轻薄,负责入参校验、调用 Service、格式化返回。 + - 复杂业务逻辑、事务处理一律封装在 Service 中。 + - 充分利用 Cool-Admin 的 CRUD 装饰器,精简标准化增删改查。 + +### 3.2 管理后台前端:React + Arco Design 规范 +- **组件优先原则**:全面使用 Arco Design 官方组件库(`@arco-design/web-react`),包括表单布局、筛选面板、表格渲染、弹窗抽屉等。严禁自制低质量同类组件。 +- **类型安全**:全面采用 TypeScript,严禁滥用 `any`。严格定义 Props 接口与服务端 API 响应契约。 +- **状态与样式**: + - 遵循现代 React 最佳实践(Hooks、函数组件、避免多余状态冗余)。 + - 优先复用 Arco 官方样式变量与工具类,保持设计一致性与出海高端商务调性。 + +### 3.3 用户端:uni-app x (App + H5) 规范 +- **语法与语言**: + - 严格按照 uni-app x 官方语法规范进行编码,采用 **uts 语言** (TypeScript 的强类型超集) 编写,遵守 uts 语法约束。 + - 采用 Vue 3 `