# OneApp 架构设计文档 > OneApp Flutter 应用的完整技术架构设计和模块说明文档站点 ## 🚀 快速开始 ### - 源文档直接在根目录维护，构建时自动拷贝 ## 🛠️ 技术栈 - **框架**: Flutter 3.0+ - **Python 3.7+** - 运行MkDocs - **PowerShell 5.0+** - 执行构建脚本（Windows自带） - **Git** - 版本控制（可选） ### 安装依赖 ```bash # 安装MkDocs Material主题 pip install mkdocs-material ``` ### 构建方式 本文档站点支持两种构建方式： - **自动构建脚本** - 一键完成所有操作（推荐） - **MkDocs手动构建** - 传统方式，需要手动处理文件 - **Docsify** - 动态文档解析（兼容支持） 提供了完整的 OneApp Flutter 应用架构设计说明。 ### 📖 主要内容 - **[架构设计文档](OneApp架构设计文档.md)** - 完整的系统架构设计文档 - **[AI聊天助手](CODE_ANALYSIS.md)** - AI聊天助手代码解析 - **[主应用架构](main_app.md)** - 主应用的详细架构说明 - **[调试工具](debug_tools.md)** - 开发调试工具使用指南 ## 📁 项目结构 ``` oneapp_docs/ ├── build-docs.ps1 # PowerShell构建脚本 ├── build-docs.bat # Windows批处理入口 ├── mkdocs.yml # MkDocs配置文件 ├── assets/ # 静态资源 │ ├── css/extra.css # 自定义样式 │ └── js/ # JavaScript文件 ├── site/ # 生成的静态站点（git忽略） ├── docs/ # 临时文档目录（git忽略，脚本自动生成） ├── *.md # 源Markdown文档 ├── account/ # 账户模块文档 ├── app_car/ # 车辆服务文档 ├── basic_uis/ # UI组件文档 ├── basic_utils/ # 工具库文档 ├── images/ # 图片资源 └── ... # 其他模块目录 ``` ### 重要说明 - `docs/` 目录由构建脚本自动生成，不需要手动维护 - `site/` 目录包含最终生成的HTML文档 - 源文档直接在根目录维护，构建时自动拷贝 ## 🛠️ 技术栈 - **框架**: Flutter 3.0+ - **语言**: Dart 3.0+ - **架构**: MVVM + 模块化 - **状态管理**: Provider + Bloc - **路由**: Flutter Modular - **网络**: Dio - **存储**: Hive + SharedPreferences ## 📖 使用指南 ### 🚀 一键构建（推荐） 本项目提供了自动化构建脚本，可以一键完成文档构建： #### Windows 用户 ```bash # 方式1: 双击运行（最简单） 双击 build-docs.bat 文件 # 方式2: PowerShell命令行 .\build-docs.ps1 # 标准构建（推荐） .\build-docs.ps1 -KeepDocs # 保留docs目录（调试用） .\build-docs.ps1 -Help # 查看帮助信息 ``` #### 构建脚本特性 - ✅ **自动拷贝** - 将源文件自动拷贝到docs目录 - ✅ **一键构建** - 执行完整的MkDocs构建流程 - ✅ **自动清理** - 构建完成后自动清理临时文件 - ✅ **Git友好** - docs目录不会被提交到版本库 - ✅ **错误处理** - 失败时自动回滚和清理 ### 在线浏览 - 使用左侧导航栏浏览不同模块 - 使用右上角搜索功能快速查找内容 - 点击主题切换按钮切换深色/浅色模式 ### MkDocs 手动部署 如果需要手动构建，可以使用以下命令： ```bash # 安装 MkDocs Material pip install mkdocs-material # 手动拷贝文件到docs目录后，在项目目录启动本地服务 mkdocs serve # 访问 http://127.0.0.1:8000 # 构建静态站点 mkdocs build ``` > **注意**: 手动构建需要自己处理文件拷贝和清理工作，推荐使用上述自动化脚本。 ### Docsify 本地部署（兼容） ```bash # 安装 docsify-cli npm install -g docsify-cli # 在项目目录启动本地服务 docsify serve # 访问 http://localhost:3000 ``` ## 🎯 文档特性 - ✅ **双构建支持** - MkDocs静态生成 + Docsify动态解析 - ✅ **Mermaid 图表支持** - 所有架构图表自动渲染 - ✅ **响应式设计** - 完美支持移动端和桌面端 - ✅ **全文搜索** - 快速查找文档内容 - ✅ **主题切换** - 支持浅色和深色主题 - ✅ **代码高亮** - 支持多种编程语言语法高亮 - ✅ **中文优化** - 完整的中文本地化支持 --- > **提示**: 文档中的所有 Mermaid 图表都支持交互式查看，点击可获得更好的阅读体验。静态站点推荐使用MkDocs构建版本获得最佳性能。