refactor: 确立独立子工程架构 (backend, admin, mpuniapp) 并同步更新 AGENTS.md 规范
30
.gitignore
vendored
@@ -1,30 +0,0 @@
|
||||
# 依赖与打包产物
|
||||
node_modules/
|
||||
dist/
|
||||
build/
|
||||
.temp/
|
||||
.cache/
|
||||
|
||||
# 环境与本地配置
|
||||
.env
|
||||
.env.local
|
||||
.env.*.local
|
||||
|
||||
# 日志与临时文件
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
lerna-debug.log*
|
||||
*.log
|
||||
|
||||
# 编辑器与系统文件
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
.idea/
|
||||
.vscode/
|
||||
*.suo
|
||||
*.ntvs*
|
||||
*.njsproj
|
||||
*.sln
|
||||
*.sw?
|
||||
62
AGENTS.md
@@ -17,21 +17,56 @@
|
||||
|
||||
---
|
||||
|
||||
## 2. 核心技术选型 (Tech Stack)
|
||||
## 2. 核心技术选型与端目录映射 (Tech Stack & Architecture)
|
||||
|
||||
项目严格采用以下官方推荐的现代化技术栈,严禁脱离官方语法规范进行非标开发:
|
||||
项目严格采用以下官方推荐的现代化技术栈,根目录下各端工程严格对应独立子目录,严禁脱离官方语法规范进行非标开发:
|
||||
|
||||
| 端 / 层次 | 核心技术选型 | 官方文档与资源 | 规范要点 |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **后端服务 (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。 |
|
||||
| 端 / 层次 | 核心技术选型 | 项目目录 | 官方文档与资源 | 规范要点 |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| **后端服务 (Backend API)** | **Cool-Admin (Node.js Midway 8.x)** | `backend/` | [https://node.cool-admin.com/](https://node.cool-admin.com/) | 基于 Midway.js + TypeScript + TypeORM。严格遵循 Cool-Admin 模块化规范(Entity / Controller / Service / Middleware),充分利用其权限、定时任务与插件生态。默认端口 9000,数据库 `crmmpdata`。 |
|
||||
| **管理后台前端 (Admin Web)** | **React + Arco Design (Arco Pro Vite)** | `admin/` | [https://arco.design/react/docs/start](https://arco.design/react/docs/start) | 字节跳动企业级设计系统与 Arco Pro 标准中后台模板。界面严格沿用 Arco Design 官方规范与组件(Table, Form, Card, Modal, Grid 等),杜绝重复造轮子。默认端口 5173,反向代理 `/api` 至后端。 |
|
||||
| **用户端应用 (User Client)** | **uni-app x (App 端 + H5 端)** | `mpuniapp/` | [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。 |
|
||||
| **系统设计与规划文档** | **PRD & UI/UX 规范** | `docs/` | - | 包含产品商业定位、6 大业务架构、分级订阅模型、Bento Grid 便当盒美学与设计规范文档。 |
|
||||
|
||||
### 2.1 物理目录映射与工程骨架 (Directory Tree)
|
||||
|
||||
```text
|
||||
CRMmp/
|
||||
├── backend/ # 【后端服务】Cool-Admin (Midway.js + TypeScript + TypeORM)
|
||||
│ ├── src/
|
||||
│ │ ├── configuration.ts # Midway 生命周期与 Cool-Admin 模块加载
|
||||
│ │ ├── config/ # 多环境配置 (config.local.ts 中数据库为 crmmpdata)
|
||||
│ │ └── modules/ # 官方模块 (base/dict/plugin/space/task/user) 与业务模块
|
||||
│ └── package.json # 后端依赖管理与脚本 (npm run dev / build)
|
||||
│
|
||||
├── admin/ # 【管理后台前端】Arco Design Pro (React + Vite + TypeScript)
|
||||
│ ├── src/
|
||||
│ │ ├── layout.tsx # Arco Pro 企业级中后台统一骨架与导航
|
||||
│ │ ├── routes.ts # 权限路由与侧边栏配置
|
||||
│ │ ├── pages/ # 仪表盘、列表、表单、详情等典型中后台页面
|
||||
│ │ └── locale/ # 中英文国际化语言包
|
||||
│ ├── vite.config.ts # Vite 配置,端口 5173,代理 /api -> http://127.0.0.1:9000
|
||||
│ └── package.json # 前端依赖管理与脚本 (npm run dev / build)
|
||||
│
|
||||
├── mpuniapp/ # 【用户端应用】uni-app x (App 端 + H5 端)
|
||||
│ ├── pages/ # 访客端名片页、Bento Grid 便当盒微官网、AI 咨询浮层
|
||||
│ ├── components/ # 跨端通用视图组件与 uni-ui 扩展
|
||||
│ ├── App.uvue # 应用入口组件 (uts/uvue)
|
||||
│ ├── main.uts # 入口 uts 脚本
|
||||
│ ├── pages.json # 页面路由与全局样式配置
|
||||
│ ├── manifest.json # 应用多端配置 (Android, iOS, Web/H5)
|
||||
│ └── package.json # 客户端工程配置与依赖
|
||||
│
|
||||
├── docs/ # 【系统设计文档】PRD、UI/UX 规范等
|
||||
├── AGENTS.md # 【核心开发规范与 Agent 协作准则】(本文档)
|
||||
└── README.md # 【项目简介】
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. 各端开发规范与准则 (Guidelines by Stack)
|
||||
|
||||
### 3.1 后端:Cool-Admin (Node.js) 规范
|
||||
### 3.1 后端:Cool-Admin (Node.js) 规范 (目录: backend/)
|
||||
- **架构范式**:严格遵循 Midway.js 依赖注入 (IoC) 与模块化结构设计。所有业务按业务域拆分为独立 Module(如 `modules/card`, `modules/crm`, `modules/ai`)。
|
||||
- **实体与数据层 (TypeORM)**:
|
||||
- 数据表字段使用下划线命名法,实体属性使用驼峰命名法。
|
||||
@@ -42,14 +77,14 @@
|
||||
- 复杂业务逻辑、事务处理一律封装在 Service 中。
|
||||
- 充分利用 Cool-Admin 的 CRUD 装饰器,精简标准化增删改查。
|
||||
|
||||
### 3.2 管理后台前端:React + Arco Design 规范
|
||||
### 3.2 管理后台前端:React + Arco Design 规范 (目录: admin/)
|
||||
- **组件优先原则**:全面使用 Arco Design 官方组件库(`@arco-design/web-react`),包括表单布局、筛选面板、表格渲染、弹窗抽屉等。严禁自制低质量同类组件。
|
||||
- **类型安全**:全面采用 TypeScript,严禁滥用 `any`。严格定义 Props 接口与服务端 API 响应契约。
|
||||
- **状态与样式**:
|
||||
- 遵循现代 React 最佳实践(Hooks、函数组件、避免多余状态冗余)。
|
||||
- 优先复用 Arco 官方样式变量与工具类,保持设计一致性与出海高端商务调性。
|
||||
|
||||
### 3.3 用户端:uni-app x (App + H5) 规范
|
||||
### 3.3 用户端:uni-app x (App + H5) 规范 (目录: mpuniapp/)
|
||||
- **语法与语言**:
|
||||
- 严格按照 uni-app x 官方语法规范进行编码,采用 **uts 语言** (TypeScript 的强类型超集) 编写,遵守 uts 语法约束。
|
||||
- 采用 Vue 3 `<script setup lang="uts">` 单文件组件 (SFC) 模式。
|
||||
@@ -136,6 +171,7 @@
|
||||
- 保证推送到远端的代码干净无杂质(严禁提交临时调试文件、无用日志打印或未验证代码)。
|
||||
6. **全局中文交流与文档**:
|
||||
- 团队内部交互、设计文档、代码注释及任务汇报均统一采用中文描述。
|
||||
- md,测试脚本,等归档存储
|
||||
|
||||
|
||||
更新版,已把**风格约束**一起并入 AI Coding 约束。可直接放入 `.cursorrules` / `CLAUDE.md`。
|
||||
@@ -151,12 +187,6 @@
|
||||
- 一屏只允许 1 个主 CTA
|
||||
|
||||
## 技术栈
|
||||
- Next.js + TypeScript + Tailwind + shadcn/ui
|
||||
- 移动端:Expo / React Native
|
||||
- 状态:Zustand + TanStack Query
|
||||
- 表单:react-hook-form + zod
|
||||
- 国际化:next-intl
|
||||
- 测试:Vitest + Playwright
|
||||
|
||||
## 设计 Token(必须引用,禁止硬编码)
|
||||
颜色 Light / Dark:
|
||||
|
||||
@@ -35,8 +35,8 @@
|
||||
|
||||
详见核心开发指引:**[AGENTS.md](./AGENTS.md)**
|
||||
|
||||
- **后端服务 (Backend)**:[Cool-Admin (Node.js)](https://node.cool-admin.com/)(基于 Midway.js + TypeScript + TypeORM)
|
||||
- **管理后台前端 (Admin Web)**:[Arco Design React](https://arco.design/react/docs/start)(字节跳动企业级设计系统)
|
||||
- **用户多端应用 (User App & H5)**:[uni-app x](https://doc.dcloud.net.cn/uni-app-x/)(DCloud 原生强类型 uts 跨端引擎,兼顾 App 和 H5)
|
||||
- **后端服务 (`backend/`)**:[Cool-Admin (Node.js)](https://node.cool-admin.com/)(基于 Midway.js + TypeScript + TypeORM)
|
||||
- **管理后台前端 (`admin/`)**:[Arco Design React](https://arco.design/react/docs/start)(字节跳动企业级设计系统)
|
||||
- **用户多端应用 (`mpuniapp/`)**:[uni-app x](https://doc.dcloud.net.cn/uni-app-x/)(DCloud 原生强类型 uts 跨端引擎,兼顾 App 和 H5)
|
||||
- **开发与交付原则**:严格 TDD 测试驱动开发、严格官方语法规范、组件高复用、极简干净代码。
|
||||
|
||||
|
||||
0
packages/admin/.gitignore → admin/.gitignore
vendored
|
之前 宽度: | 高度: | 大小: 579 B 之后 宽度: | 高度: | 大小: 579 B |
|
之前 宽度: | 高度: | 大小: 2.0 KiB 之后 宽度: | 高度: | 大小: 2.0 KiB |
|
之前 宽度: | 高度: | 大小: 1.3 KiB 之后 宽度: | 高度: | 大小: 1.3 KiB |
|
之前 宽度: | 高度: | 大小: 6.5 KiB 之后 宽度: | 高度: | 大小: 6.5 KiB |
|
之前 宽度: | 高度: | 大小: 6.4 KiB 之后 宽度: | 高度: | 大小: 6.4 KiB |
|
之前 宽度: | 高度: | 大小: 13 KiB 之后 宽度: | 高度: | 大小: 13 KiB |
|
之前 宽度: | 高度: | 大小: 6.3 KiB 之后 宽度: | 高度: | 大小: 6.3 KiB |