1 line
20 KiB
JSON
1 line
20 KiB
JSON
{"projectName":"NoteApp","domain":"note","contract":{"projectName":"NoteApp","domain":"note","entities":[{"name":"User","table":"users","description":"系统用户","fields":[{"name":"id","type":"UUID","isPrimary":true,"isAuto":true},{"name":"username","type":"VARCHAR(128)","required":true,"unique":true,"validation":{"minLength":2,"maxLength":50}},{"name":"password_hash","type":"VARCHAR(256)","required":true,"isSecret":true},{"name":"nickname","type":"VARCHAR(128)"},{"name":"role","type":"VARCHAR(32)","defaultValue":"user","enum":["user","admin"]},{"name":"phone","type":"VARCHAR(20)"},{"name":"avatar_url","type":"TEXT"},{"name":"created_at","type":"TIMESTAMP","isAuto":true},{"name":"updated_at","type":"TIMESTAMP","isAuto":true}],"relationships":[]},{"name":"Customers","table":"customers","description":"客户管理表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"name","type":"VARCHAR(128)","required":true,"isPrimary":false,"isAuto":false},{"name":"email","type":"VARCHAR(256)","required":false,"isPrimary":false,"isAuto":false},{"name":"phone","type":"VARCHAR(20)","required":false,"isPrimary":false,"isAuto":false},{"name":"company","type":"VARCHAR(128)","required":false,"isPrimary":false,"isAuto":false},{"name":"source","type":"VARCHAR(64)","required":false,"isPrimary":false,"isAuto":false},{"name":"tags","type":"JSONB","required":false,"isPrimary":false,"isAuto":true},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]},{"name":"SalesPipeline","table":"sales_pipeline","description":"销售漏斗表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"customer_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"customers","fkColumn":"id"},{"name":"stage","type":"VARCHAR(32)","required":true,"isPrimary":false,"isAuto":false},{"name":"amount","type":"DECIMAL(12,2)","required":false,"isPrimary":false,"isAuto":false},{"name":"probability","type":"INTEGER","required":false,"isPrimary":false,"isAuto":false},{"name":"expected_close","type":"DATE","required":false,"isPrimary":false,"isAuto":false},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"},{"type":"belongsTo","entity":"customers","via":"customer_id"}]},{"name":"FollowUps","table":"follow_ups","description":"跟进记录表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"customer_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"customers","fkColumn":"id"},{"name":"type","type":"VARCHAR(32)","required":false,"isPrimary":false,"isAuto":false},{"name":"content","type":"TEXT","required":false,"isPrimary":false,"isAuto":false},{"name":"next_action","type":"VARCHAR(256)","required":false,"isPrimary":false,"isAuto":false},{"name":"next_action_date","type":"DATE","required":false,"isPrimary":false,"isAuto":false},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"},{"type":"belongsTo","entity":"customers","via":"customer_id"}]},{"name":"Dashboard","table":"dashboard","description":"数据分析仪表盘表","fields":[{"name":"id","type":"UUID","required":true,"isPrimary":true,"isAuto":true},{"name":"user_id","type":"UUID","required":false,"isPrimary":false,"isAuto":false,"fkEntity":"users","fkColumn":"id"},{"name":"name","type":"VARCHAR(128)","required":true,"isPrimary":false,"isAuto":false},{"name":"description","type":"TEXT","required":false,"isPrimary":false,"isAuto":false},{"name":"color","type":"VARCHAR(7)","required":false,"isPrimary":false,"isAuto":false},{"name":"created_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true},{"name":"updated_at","type":"TIMESTAMPTZ","required":false,"isPrimary":false,"isAuto":true}],"relationships":[{"type":"belongsTo","entity":"users","via":"user_id"}]}],"auth":{"registrationFields":["username","password","nickname"],"loginFields":["username","password"],"jwtPayload":["userId","username","role"],"passwordPolicy":{"minLength":6,"requireSpecial":false}},"permissions":[{"role":"admin","allow":["*"]},{"role":"user","allow":["read:own","create:*","update:own","delete:own"]}],"fieldMapping":{"snakeToCamel":{"created_at":"createdAt","updated_at":"updatedAt","user_id":"userId","password_hash":"passwordHash","avatar_url":"avatarUrl","customer_id":"customerId","expected_close":"expectedClose","next_action":"nextAction","next_action_date":"nextActionDate","id":"id","username":"username","nickname":"nickname","role":"role","phone":"phone","title":"title","description":"description","status":"status","data":"data","amount":"amount","party_a":"partyA","party_b":"partyB","signed_at":"signedAt","expires_at":"expiresAt","file_url":"fileUrl","entity_type":"entityType","entity_id":"entityId","applicant_id":"applicantId","form_data":"formData","name":"name","email":"email","company":"company","source":"source","tags":"tags","breed":"breed","species":"species","birth_date":"birthDate","weight_kg":"weightKg","price":"price","stock":"stock","images":"images","total_amount":"totalAmount","address_id":"addressId","remind_at":"remindAt","message":"message","sent":"sent"},"camelToSnake":{"createdAt":"created_at","updatedAt":"updated_at","userId":"user_id","passwordHash":"password_hash","avatarUrl":"avatar_url","customerId":"customer_id","expectedClose":"expected_close","nextAction":"next_action","nextActionDate":"next_action_date","id":"id","username":"username","nickname":"nickname","role":"role","phone":"phone","title":"title","description":"description","status":"status","data":"data","amount":"amount","partyA":"party_a","partyB":"party_b","signedAt":"signed_at","expiresAt":"expires_at","fileUrl":"file_url","entityType":"entity_type","entityId":"entity_id","applicantId":"applicant_id","formData":"form_data","name":"name","email":"email","company":"company","source":"source","tags":"tags","breed":"breed","species":"species","birthDate":"birth_date","weightKg":"weight_kg","price":"price","stock":"stock","images":"images","totalAmount":"total_amount","addressId":"address_id","remindAt":"remind_at","message":"message","sent":"sent"}},"validation":{"User":{"username":{"minLength":2,"maxLength":50,"required":true,"unique":true},"password_hash":{"required":true},"role":{"enum":["user","admin"],"defaultValue":"user"}},"Customers":{"id":{"required":true},"name":{"required":true}},"SalesPipeline":{"id":{"required":true},"stage":{"required":true}},"FollowUps":{"id":{"required":true}},"Dashboard":{"id":{"required":true},"name":{"required":true}}}},"techStack":{"frontend":"React Native 0.76 + Expo / Flutter 3.x","backend":"NestJS + Prisma","database":"PostgreSQL 15 + Redis 7 + MinIO(文件存储)","deployment":"Docker Compose + Nginx / K8s(规模化)","considerations":[]},"architectureDiagram":"┌─────────────────────────────────────────────────────────┐\n│ NoteApp — System Architecture │\n├─────────────────────────────────────────────────────────┤\n│ │\n│ ┌──────────────────────┐ ┌──────────────────────┐ │\n│ │ Client Layer │ │ Admin / Web │ │\n│ │ React Native 0.76 + Expo / Flutter 3.x │ │ React + Vite (Web) │ │\n│ └──────────┬───────────┘ └──────────┬───────────┘ │\n│ │ │ │\n│ └──────────┬────────────────┘ │\n│ │ │\n│ ┌─────────▼──────────┐ │\n│ │ API Gateway │ │\n│ │ Nginx / Kong │ │\n│ └─────────┬──────────┘ │\n│ │ │\n│ ┌─────────▼──────────┐ │\n│ │ Backend Services │ │\n│ │ NestJS + Prisma │ │\n│ └─────────┬──────────┘ │\n│ │ │\n│ ┌───────────────┼───────────────┐ │\n│ │ │ │ │\n│ ┌─────▼─────┐ ┌──────▼──────┐ ┌────▼─────┐ │\n│ │ PostgreSQL 15│ │ Redis Cache │ │ MinIO │ │\n│ │ Primary │ │ Session │ │ Files │ │\n│ └───────────┘ └─────────────┘ └──────────┘ │\n│ │\n├─────────────────────────────────────────────────────────┤\n│ Modules: │\n│ 1 客户管理 │\n│ 2 销售漏斗 │\n│ 3 跟进记录 │\n│ 4 Analytics │\n│ 5 编辑器 │\n│ 6 搜索引擎 │\n│ │\n└─────────────────────────────────────────────────────────┘","dataFlows":[{"page":"客户管理","route":"/customers","description":"客户管理","dataFlow":["GET /api/customers → 获取客户管理列表","POST /api/customers → 创建客户管理"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"销售漏斗","route":"/sales_pipeline","description":"销售漏斗","dataFlow":["GET /api/sales_pipeline → 获取销售漏斗列表","POST /api/sales_pipeline → 创建销售漏斗"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"跟进记录","route":"/follow_ups","description":"跟进记录","dataFlow":["GET /api/follow_ups → 获取跟进记录列表","POST /api/follow_ups → 创建跟进记录"],"direction":"Client → API Gateway → Backend → Database → Response → Client"},{"page":"数据分析仪表盘","route":"/dashboard","description":"数据分析仪表盘","dataFlow":["GET /api/dashboard → 获取数据分析仪表盘列表","POST /api/dashboard → 创建数据分析仪表盘"],"direction":"Client → API Gateway → Backend → Database → Response → Client"}],"modules":[{"name":"客户管理","label":"客户管理","features":["客户管理"],"responsibilities":["提供 客户管理 相关功能"]},{"name":"销售漏斗","label":"销售漏斗","features":["销售漏斗"],"responsibilities":["提供 销售漏斗 相关功能"]},{"name":"跟进记录","label":"跟进记录","features":["跟进记录"],"responsibilities":["提供 跟进记录 相关功能"]},{"name":"analytics","label":"Analytics","features":["数据分析仪表盘"],"responsibilities":["提供 数据分析仪表盘 相关功能"]},{"name":"editor","label":"编辑器","features":["笔记编辑"],"responsibilities":["提供 笔记编辑 相关功能"]},{"name":"search","label":"搜索引擎","features":["全文搜索"],"responsibilities":["提供 全文搜索 相关功能"]}],"databaseSchema":[{"table":"users","description":"用户表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"phone","type":"VARCHAR(20)","constraints":"UNIQUE"},{"name":"nickname","type":"VARCHAR(64)"},{"name":"avatar_url","type":"TEXT"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_users_phone ON users(phone)"]},{"table":"customers","description":"客户管理表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"name","type":"VARCHAR(128)","constraints":"NOT NULL"},{"name":"email","type":"VARCHAR(256)"},{"name":"phone","type":"VARCHAR(20)"},{"name":"company","type":"VARCHAR(128)"},{"name":"source","type":"VARCHAR(64)"},{"name":"tags","type":"JSONB","constraints":"DEFAULT '[]'"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_customers_user ON customers(user_id)"]},{"table":"sales_pipeline","description":"销售漏斗表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"customer_id","type":"UUID","constraints":"FK → customers.id"},{"name":"stage","type":"VARCHAR(32)","constraints":"NOT NULL"},{"name":"amount","type":"DECIMAL(12,2)"},{"name":"probability","type":"INTEGER"},{"name":"expected_close","type":"DATE"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_sales_pipeline_user ON sales_pipeline(user_id)"]},{"table":"follow_ups","description":"跟进记录表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"customer_id","type":"UUID","constraints":"FK → customers.id"},{"name":"type","type":"VARCHAR(32)"},{"name":"content","type":"TEXT"},{"name":"next_action","type":"VARCHAR(256)"},{"name":"next_action_date","type":"DATE"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_follow_ups_user ON follow_ups(user_id)"]},{"table":"dashboard","description":"数据分析仪表盘表","fields":[{"name":"id","type":"UUID","constraints":"PK, DEFAULT gen_random_uuid()"},{"name":"user_id","type":"UUID","constraints":"FK → users.id"},{"name":"name","type":"VARCHAR(128)","constraints":"NOT NULL"},{"name":"description","type":"TEXT"},{"name":"color","type":"VARCHAR(7)"},{"name":"created_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"},{"name":"updated_at","type":"TIMESTAMPTZ","constraints":"DEFAULT NOW()"}],"indexes":["idx_dashboard_user ON dashboard(user_id)"]}],"apiDesign":[{"resource":"auth","basePath":"/api/auth","endpoints":[{"method":"POST","path":"/api/auth/login","description":"用户登录"},{"method":"GET","path":"/api/auth/me","description":"获取当前用户"}]},{"resource":"customers","basePath":"/api/customers","endpoints":[{"method":"GET","path":"/api/customers","description":"获取客户管理列表"},{"method":"POST","path":"/api/customers","description":"创建客户管理"}]},{"resource":"dashboard","basePath":"/api/dashboard","endpoints":[{"method":"GET","path":"/api/dashboard","description":"获取数据分析仪表盘列表"},{"method":"POST","path":"/api/dashboard","description":"创建数据分析仪表盘"}]},{"resource":"follow_ups","basePath":"/api/follow_ups","endpoints":[{"method":"GET","path":"/api/follow_ups","description":"获取跟进记录列表"},{"method":"POST","path":"/api/follow_ups","description":"创建跟进记录"}]},{"resource":"sales_pipeline","basePath":"/api/sales_pipeline","endpoints":[{"method":"GET","path":"/api/sales_pipeline","description":"获取销售漏斗列表"},{"method":"POST","path":"/api/sales_pipeline","description":"创建销售漏斗"}]}],"directoryStructure":["noteapp/","├── apps/","│ ├── mobile/ # React Native / Flutter 移动端","│ │ ├── src/","│ │ │ ├── screens/ # 页面组件","│ │ │ │ ├── 客户管理/","│ │ │ │ ├── 销售漏斗/","│ │ │ │ ├── 跟进记录/","│ │ │ │ ├── analytics/","│ │ │ ├── components/ # 通用组件","│ │ │ ├── hooks/ # 自定义 Hooks","│ │ │ ├── services/ # API 调用层","│ │ │ ├── store/ # 状态管理","│ │ │ └── utils/ # 工具函数","│ │ ├── app.json","│ │ └── package.json","│ └── web/ # Web 管理后台","│ ├── src/","│ │ ├── pages/","│ │ ├── components/","│ │ └── layouts/","│ └── package.json","├── packages/","│ └── shared/ # 共享类型/常量","├── server/ # NestJS 后端服务","│ ├── src/","│ │ ├── modules/ # 业务模块","│ │ │ ├── 客户管理/","│ │ │ │ ├── 客户管理.controller.ts","│ │ │ │ ├── 客户管理.service.ts","│ │ │ │ ├── 客户管理.module.ts","│ │ │ │ └── dto/","│ │ │ ├── 销售漏斗/","│ │ │ │ ├── 销售漏斗.controller.ts","│ │ │ │ ├── 销售漏斗.service.ts","│ │ │ │ ├── 销售漏斗.module.ts","│ │ │ │ └── dto/","│ │ │ ├── 跟进记录/","│ │ │ │ ├── 跟进记录.controller.ts","│ │ │ │ ├── 跟进记录.service.ts","│ │ │ │ ├── 跟进记录.module.ts","│ │ │ │ └── dto/","│ │ │ ├── analytics/","│ │ │ │ ├── analytics.controller.ts","│ │ │ │ ├── analytics.service.ts","│ │ │ │ ├── analytics.module.ts","│ │ │ │ └── dto/","│ │ │ ├── editor/","│ │ │ │ ├── editor.controller.ts","│ │ │ │ ├── editor.service.ts","│ │ │ │ ├── editor.module.ts","│ │ │ │ └── dto/","│ │ ├── common/ # 通用(guards, filters, interceptors)","│ │ ├── prisma/ # Prisma ORM","│ │ │ └── schema.prisma","│ │ ├── config/ # 环境配置","│ │ └── main.ts","│ ├── test/","│ ├── Dockerfile","│ └── package.json","├── docker-compose.yml","├── .github/workflows/ # CI/CD","│ └── ci.yml","├── .env.example","├── README.md","└── turbo.json # Monorepo 配置"],"deployment":{"environments":["development","staging","production"],"strategy":"Docker Compose + Nginx / K8s(规模化)","services":["API Server (NestJS)","PostgreSQL 15","Redis 7"],"ci":"GitHub Actions → Build → Test → Deploy"},"meta":{"generatedAt":"2026-06-05T22:08:34.079Z","sourceDomain":"note","moduleCount":6,"tableCount":5,"apiEndpointCount":10}} |