docs: update README and add pages routes

This commit is contained in:
comlibmb
2026-01-28 09:26:56 +08:00
parent 83d10a0a78
commit 3e89513e8b
2 changed files with 143 additions and 99 deletions

112
PAGES_ROUTES.md Normal file
View File

@@ -0,0 +1,112 @@
# Pages Routes
Generated from root pages.json (pages + subPackages).
## Pages
- pages/user/login
- pages/user/boot
- pages/user/register
- pages/user/forgot-password
- pages/user/terms
- pages/user/center
- pages/user/profile
- pages/mall/consumer/index
- pages/mall/consumer/category
- pages/mall/consumer/messages
- pages/mall/consumer/cart
- pages/mall/consumer/profile
## SubPackages
### pages/mall/consumer
- pages/mall/consumer/settings
- pages/mall/consumer/wallet
- pages/mall/consumer/search
- pages/mall/consumer/product-detail
- pages/mall/consumer/shop-detail
- pages/mall/consumer/coupons
- pages/mall/consumer/favorites
- pages/mall/consumer/footprint
- pages/mall/consumer/address-list
- pages/mall/consumer/address-edit
- pages/mall/consumer/checkout
- pages/mall/consumer/payment
- pages/mall/consumer/payment-success
- pages/mall/consumer/orders
- pages/mall/consumer/order-detail
- pages/mall/consumer/logistics
- pages/mall/consumer/review
- pages/mall/consumer/refund
- pages/mall/consumer/apply-refund
- pages/mall/consumer/refund-review
- pages/mall/consumer/chat
- pages/mall/consumer/subscription/plan-list
- pages/mall/consumer/subscription/plan-detail
- pages/mall/consumer/subscription/subscribe-checkout
- pages/mall/consumer/subscription/my-subscriptions
### pages/mall/delivery
- pages/mall/delivery/index
- pages/mall/delivery/order-detail
- pages/mall/delivery/profile
- pages/mall/delivery/order-history
- pages/mall/delivery/earnings
- pages/mall/delivery/tasks
- pages/mall/delivery/task-detail
- pages/mall/delivery/profile-edit
- pages/mall/delivery/ratings
- pages/mall/delivery/vehicle
- pages/mall/delivery/vehicle-add
- pages/mall/delivery/vehicle-edit
- pages/mall/delivery/settings
### pages/mall/analytics
- pages/mall/analytics/index
- pages/mall/analytics/profile
- pages/mall/analytics/sales-report
- pages/mall/analytics/user-analysis
- pages/mall/analytics/product-insights
- pages/mall/analytics/delivery-analysis
- pages/mall/analytics/coupon-analysis
- pages/mall/analytics/market-trends
- pages/mall/analytics/custom-report
- pages/mall/analytics/report-detail
- pages/mall/analytics/data-detail
- pages/mall/analytics/insight-detail
- pages/mall/analytics/test/test-connection
### pages/mall/admin
- pages/mall/admin/homePage/index
- pages/mall/admin/user-management
- pages/mall/admin/product-management
- pages/mall/admin/order-management
- pages/mall/admin/finance-management
- pages/mall/admin/user-statistics
- pages/mall/admin/system-settings
- pages/mall/admin/profile
- pages/mall/admin/delivery-management
- pages/mall/admin/merchant-management
- pages/mall/admin/merchant-review
- pages/mall/admin/product-review
- pages/mall/admin/refund-review
- pages/mall/admin/complaints
- pages/mall/admin/notifications
- pages/mall/admin/activity-log
- pages/mall/admin/subscription/plan-management
- pages/mall/admin/subscription/user-subscriptions
- pages/mall/admin/marketing/coupon/coupon-management
- pages/mall/admin/marketing/coupon/list
- pages/mall/admin/marketing/coupon/receive
- pages/mall/admin/marketing/points/index
- pages/mall/admin/marketing/signin/rule
- pages/mall/admin/marketing/signin/record
### pages/mall/merchant
- pages/mall/merchant/index
- pages/mall/merchant/product-detail
- pages/mall/merchant/profile
### pages/mall/service
- pages/mall/service/index
- pages/mall/service/profile
- pages/mall/service/ticket-detail

130
README.md
View File

@@ -1,108 +1,40 @@
# 🛍️ 商城系统模块 (Mall System Module)
# 🛍️ Mall (uni-app / uvue)
目录包含完整的商城系统模块,已从主项目中独立出来,可作为独立仓库使用
仓库为 uni-appuvue/uts商城项目包含消费者端、配送端、数据分析、管理后台、商家端、客服端等模块
## 📁 目录结构
## 📦 路由与分包
本项目使用 **根目录 `pages.json`** 作为路由入口配置,并对 `pages/mall/*` 模块进行了分包subPackages拆分。
- `tabBar`消费者端consumer5 个主入口页
- `subPackages`consumer 非 tab 页、delivery、analytics、admin、merchant、service 等模块按业务分包
页面路径清单见:`PAGES_ROUTES.md`
## 📁 目录结构(核心)
```
mall/
├── doc_mall/ # 文档和数据库脚本
├── database/ # 数据库脚本目录
├── analysis/ # 分析文档目录
├── reports/ # 生成报告目录
└── *.md # 各类文档和迁移指南
├── pages/ # 前端页面代码
└── mall/ # 商城页面
├── admin/ # 管理端页面
├── analytics/ # 数据分析端页面
│ ├── consumer/ # 消费者端页面
│ ├── delivery/ # 配送端页面
│ ├── merchant/ # 商家端页面
│ ├── service/ # 客服端页面
│ └── nfc/ # NFC支付页面
└── types/ # 类型定义
└── mall-types.uts # 商城系统类型定义
pages/
user/ # 登录/注册/用户中心等公共页面
mall/
consumer/ # 消费者端
delivery/ # 配送端
analytics/ # 数据分析
admin/ # 管理后台
merchant/ # 商家端
service/ # 客服端
nfc/ # NFC相关
components/
utils/
ak/
```
## 📊 迁移统计
## 🚀 开发说明
- **文档和数据库脚本**: 48+ 个文件 (`doc_mall/`)
- **前端页面代码**: 45+ 个文件 (`pages/mall/`)
- **类型定义**: 1 个文件 (`types/mall-types.uts`)
- 使用 HBuilderX 或 uni-app CLI 运行与编译
- `pages.json` 中分包页面请用 `uni.navigateTo` 进入;`uni.switchTab` 仅用于 `tabBar` 页面
## 🚀 快速开始
## ⚠️ 注意事项
### 1. 查看迁移指南
- **完整迁移指南**: [doc_mall/MIGRATION_GUIDE.md](./doc_mall/MIGRATION_GUIDE.md)
- **迁移检查清单**: [doc_mall/MIGRATION_CHECKLIST.md](./doc_mall/MIGRATION_CHECKLIST.md)
- **快速开始**: [doc_mall/QUICK_START_MIGRATION.md](./doc_mall/QUICK_START_MIGRATION.md)
### 2. 配置数据库
执行数据库脚本创建表结构:
```bash
# 方式1: 通过 Supabase Dashboard SQL Editor
# 打开 doc_mall/database/complete_mall_database.sql 并执行
# 方式2: 通过 psql 命令行
psql -h localhost -U postgres -d your_database -f doc_mall/database/complete_mall_database.sql
```
### 3. 配置 Supabase 连接
创建配置文件,设置 Supabase 项目 URL 和 API Key。
### 4. 更新导入路径
检查并更新代码中的导入路径,确保指向正确的位置。
## 📚 核心文档
### 技术文档
- [技术实现拆解](./doc_mall/TECHNICAL_IMPLEMENTATION.md) - 详细的技术实现说明
- [模块深度分析](./doc_mall/MODULE_ANALYSIS.md) - 模块架构和设计理念
- [前后端联调指南](./doc_mall/FRONTEND_BACKEND_DEBUGGING.md) - 开发调试指南
### 数据库文档
- [完整部署指南](./doc_mall/database/complete_deployment_guide.md) - 数据库部署步骤
- [快速部署指南](./doc_mall/database/deployment_guide.md) - 快速部署方法
- [数据库创建报告](./doc_mall/database/database_creation_report.md) - 数据库结构说明
## 🔧 迁移到新仓库
如果你需要将本模块迁移到一个完全独立的 Git 仓库,可以使用提供的迁移脚本:
### Windows (PowerShell)
```powershell
cd doc_mall
.\migrate.ps1 -TargetPath "D:\path\to\new-repo"
```
### Linux/Mac (Bash)
```bash
cd doc_mall
chmod +x migrate.sh
./migrate.sh /path/to/new-repo
```
详细步骤请参考 [MIGRATION_GUIDE.md](./doc_mall/MIGRATION_GUIDE.md)。
## 📝 注意事项
1. **用户表依赖**: 商城系统依赖 `ak_users` 用户表,迁移时需要确定处理方案(独立表/复用表/API服务
2. **Supabase 配置**: 需要配置 Supabase 项目连接信息
3. **路径更新**: 迁移后需要更新代码中的导入路径
4. **数据库脚本**: 需要按顺序执行数据库脚本
## 📞 支持
- 查看文档: 参考 `doc_mall/` 目录下的相关文档
- 迁移问题: 参考 [MIGRATION_GUIDE.md](./doc_mall/MIGRATION_GUIDE.md) 中的常见问题部分
---
**迁移日期**: 2025年1月
**版本**: v1.0
**状态**: ✅ 已独立迁移到 mall/ 目录
- 请避免提交本地环境相关配置(如 `ak/config.uts`)到仓库(已通过 `.gitignore` 处理)
- 分包页面路径变更请同步更新 `pages.json`