Appearance
快速开始
MovieApp 是一个涵盖移动端 App、后端服务与后台管理站点的完整产品线。本套文档在 movieappDocs 仓库中维护,目标是在同一地点集中沉淀研发规范、接口契约与发布信息。
文档结构
- 指南:研发流程、环境与部署操作手册。
- 页面映射:在《页面接口映射》中,对照每个 App 页面与接口、后台配置和数据库的对应关系。
- 接口文档:移动端(
api/mobile/v1)与后台管理(auth、vod、appConfig等)接口的统一描述。 - 发布页:位于
release/目录,用于向干系人同步版本亮点与交付状态。
代码仓库布局
| 模块 | 代码位置 | 简述 |
|---|---|---|
| 移动端 App | /Users/937bb/Documents/project/movieappKT | Kotlin/Android 实现,内置基础 API 文档草稿。 |
| 后端服务 | /Users/937bb/Documents/project/movieappAdmin-backend | NestJS + TypeORM,向移动端与后台管理提供接口。 |
| 后台管理前端 | /Users/937bb/Documents/project/movieappAdmin-frontend | Vue3 + Naive UI 的管理控制台。 |
| 文档与发布页 | /Users/937bb/Documents/project/movieappDocs | 本仓库,使用 VitePress 编写开发文档。 |
快速查看文档
- 在当前仓库执行
npm install或pnpm install。 - 启动本地文档站点:bash
npm run docs:dev - 打开浏览器访问
http://localhost:5173(默认端口),即可浏览全部文档。
研发流程概览
- 拉取代码:更新三个业务仓库与文档仓库,确保接口契约同步。
- 准备环境:按《本地开发环境》配置 Android Studio、Node.js、MySQL、Redis 等依赖。
- 开发实现:
- 移动端功能遵循《代码结构约定》中约定的模块划分。
- 后端接口调整后立即更新本仓库的接口章节。
- 联调与验证:对照接口章节中的示例请求/响应逐项核对。
- 部署上线:参考《部署与上线》,完成后回填发布页。
建议在迭代伊始即补充或修订文档,使其与代码保持同步,避免后补成本。