新人入门指南.md 3.11 KB

新人入门指南

项目概览

Manulife WeApp(臻奇智荟圈)是面向内部同事的财富管理小程序,核心围绕产品信息、资料内容与计划书流程展开,支持文档预览、消息通知与反馈闭环。

业务模块

  • 产品与资料:产品中心、产品详情、分类列表、资料列表、周热门资料
  • 业务场景:签单相关、家办业务
  • 计划书:计划书列表、提交结果页
  • 内容检索:搜索页面统一入口
  • 消息与反馈:消息列表/详情、反馈提交/历史
  • 个人中心:我的、头像、帮助中心、收藏、登录/引导页

页面清单(与路由一致)

  1. 首页:pages/index/index
  2. 搜索:pages/search/index
  3. WebView:pages/webview/index
  4. 文档预览:pages/document-preview/index
  5. 文档演示:pages/document-demo/index
  6. 引导页:pages/onboarding/index
  7. 家办业务:pages/family-office/index
  8. 产品中心:pages/product-center/index
  9. 产品详情:pages/product-detail/index
  10. 分类列表:pages/category-list/index
  11. 资料列表:pages/material-list/index
  12. 周热门资料:pages/week-hot-material/index
  13. 签单相关:pages/signing/index
  14. 我的:pages/mine/index
  15. 计划书:pages/plan/index
  16. 计划书提交结果:pages/plan-submit-result/index
  17. 收藏:pages/favorites/index
  18. 头像编辑:pages/avatar/index
  19. 反馈列表:pages/feedback-list/index
  20. 意见反馈:pages/feedback/index
  21. 登录:pages/login/index
  22. 帮助中心:pages/help-center/index
  23. 消息列表:pages/message/index
  24. 消息详情:pages/message-detail/index
  25. 视频播放:pages/video-player/index

本地开发

pnpm install
pnpm dev:weapp

目录速览

  • src/pages/:业务页面
  • src/components/:通用组件(文档预览、列表、导航、计划书组件等)
  • src/composables/:组合式逻辑(权限、文件操作、列表、埋点等)
  • src/api/:接口封装
  • docs/:项目文档与流程说明

常用文档入口

常见任务

新增页面

  1. src/pages/ 新增页面目录与 index.vue
  2. src/app.config.js 添加路由
  3. 如果需要复用布局,优先复用 NavHeaderTabBar

联调接口

  1. docs/api-specs/ 更新接口文档
  2. docs/api-docs/API 集成日志.md 记录联调状态
  3. src/api/ 添加对应接口封装

新人第一天建议

  1. 先通读 README 与本指南
  2. 阅读页面路由与业务模块对照表
  3. 打开首页、产品中心、计划书、消息模块熟悉主流程
  4. 📦 标准化 - 统一的代码格式
  5. 🔧 易维护 - 单一数据源,易于更新

开始使用

pnpm api:generate

查看文档

cat README_API_GENERATOR.md

祝你使用愉快!🚀