mirror of
https://gitee.com/java110/MicroCommunityWeb.git
synced 2026-02-24 05:46:03 +08:00
127 lines
3.9 KiB
Markdown
127 lines
3.9 KiB
Markdown
# HC物业管理系统 - 开发文档
|
|
|
|
欢迎来到物业管理系统开发文档！这里包含了小白开发者快速上手所需的所有信息。
|
|
|
|
## 📚 文档目录
|
|
|
|
### 🚀 快速上手
|
|
- **[开发者快速上手指南](./开发者快速上手指南.md)** - 项目概述、技术栈、开发规范
|
|
- **[项目架构图](./项目架构图.md)** - 整体架构、目录结构、技术架构详解
|
|
- **[开发环境配置指南](./开发环境配置指南.md)** - 环境搭建、配置详解、常见问题解决
|
|
|
|
## 🎯 适合人群
|
|
|
|
- **前端新手** - 刚接触 Vue 的开发者
|
|
- **项目新人** - 刚加入团队需要了解项目的开发者
|
|
- **技术调研** - 需要了解项目技术架构的人员
|
|
|
|
## 🏗️ 项目简介
|
|
|
|
**物业管理系统** 是一个基于 Vue 2 的企业级 Web 应用，提供完整的物业管理功能：
|
|
|
|
- 🏠 **社区管理** - 小区、楼栋、房屋管理
|
|
- 👥 **业主管理** - 业主信息、家庭成员、车辆管理
|
|
- 💰 **费用管理** - 物业费、水电费、停车费管理
|
|
- 🔧 **工单管理** - 维修、投诉、巡检工单
|
|
- 📱 **设备管理** - 门禁、监控、充电桩管理
|
|
- 📊 **报表统计** - 各类数据统计和报表
|
|
|
|
## 🛠️ 技术栈
|
|
|
|
- **前端框架**: Vue 2.6.14
|
|
- **UI 组件库**: Element UI 2.15.6
|
|
- **路由管理**: Vue Router 3.5.1
|
|
- **HTTP 客户端**: Axios 0.21.1
|
|
- **国际化**: Vue I18n 8.26.7
|
|
- **图表库**: ECharts 5.6.0
|
|
- **构建工具**: Vue CLI 4.5.0
|
|
|
|
## 🚀 快速开始
|
|
|
|
### 1. 环境要求
|
|
- Node.js >= 12.0.0
|
|
- npm >= 6.0.0
|
|
- Vue CLI >= 4.5.0
|
|
|
|
### 2. 安装启动
|
|
```bash
|
|
# 克隆项目
|
|
git clone [项目地址]
|
|
cd MicroCommunityWeb
|
|
|
|
# 安装依赖
|
|
npm install
|
|
|
|
# 启动开发服务器
|
|
npm run dev
|
|
```
|
|
|
|
### 3. 访问应用
|
|
- 开发地址: http://localhost:3000
|
|
- 自动打开浏览器: 是
|
|
|
|
## 📖 学习路径
|
|
|
|
### 第一阶段：环境搭建
|
|
1. 阅读 [开发环境配置指南](./开发环境配置指南.md)
|
|
2. 安装必要的开发工具
|
|
3. 配置开发环境
|
|
4. 成功启动项目
|
|
|
|
### 第二阶段：项目了解
|
|
1. 阅读 [项目架构图](./项目架构图.md)
|
|
2. 了解项目目录结构
|
|
3. 理解技术架构
|
|
4. 熟悉开发规范
|
|
|
|
### 第三阶段：开始开发
|
|
1. 阅读 [开发者快速上手指南](./开发者快速上手指南.md)
|
|
2. 学习 Vue 2 基础语法
|
|
3. 熟悉 Element UI 组件
|
|
4. 开始编写代码
|
|
|
|
## 🔍 常见问题
|
|
|
|
### 新手常见问题
|
|
- **Q: 如何修改页面标题？**
|
|
A: 参考 [开发者快速上手指南](./开发者快速上手指南.md) 中的页面标题设置部分
|
|
|
|
- **Q: 下拉框不显示内容怎么办？**
|
|
A: 参考 [开发者快速上手指南](./开发者快速上手指南.md) 中的常见问题部分
|
|
|
|
- **Q: 如何添加新的页面？**
|
|
A: 参考 [开发者快速上手指南](./开发者快速上手指南.md) 中的开发流程部分
|
|
|
|
### 环境配置问题
|
|
- **Q: npm install 失败怎么办？**
|
|
A: 参考 [开发环境配置指南](./开发环境配置指南.md) 中的依赖安装问题部分
|
|
|
|
- **Q: 开发服务器启动失败？**
|
|
A: 参考 [开发环境配置指南](./开发环境配置指南.md) 中的开发服务器问题部分
|
|
|
|
## 📞 获取帮助
|
|
|
|
### 文档资源
|
|
- 项目 README: [../README.md](../README.md)
|
|
- 安装说明: [../install.md](../install.md)
|
|
- 官方文档: [Vue 2 官方文档](https://v2.vuejs.org/)
|
|
|
|
### 团队支持
|
|
- 遇到问题先查看本文档
|
|
- 搜索现有 issue 避免重复
|
|
- 联系团队成员获取帮助
|
|
|
|
## 🎉 开始你的开发之旅
|
|
|
|
现在你已经了解了项目的基本情况，建议按照以下顺序阅读文档：
|
|
|
|
1. **[开发环境配置指南](./开发环境配置指南.md)** - 先搭建好开发环境
|
|
2. **[项目架构图](./项目架构图.md)** - 了解项目整体结构
|
|
3. **[开发者快速上手指南](./开发者快速上手指南.md)** - 学习开发规范和流程
|
|
|
|
**祝您开发愉快！** 🚀
|
|
|
|
---
|
|
|
|
*最后更新时间: 2024年*
|
|
*文档维护: 开发团队* |