diff --git a/README.md b/README.md index 70553162038531d9b01918633f195460b14ae2d1..24a02d3423c2f66236372c6d1725c3fa6db6f894 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,70 @@ + + # power-guard-app #### 介绍 -微信小程序页面 + +power-guard-app 是一款基于微信小程序的应用程序,主要用于电力监测与保护功能。该小程序旨在为用户提供便捷的电力管理体验,帮助用户实时监控电力设备状态、接收异常报警信息并进行相关操作。 #### 软件架构 -软件架构说明 +本项目采用微信小程序原生开发框架构建,主要包含以下核心模块: + +- **页面层 (pages/)**:包含各个业务页面,如首页、设备列表、详情页面等 +- **公共组件 (components/)**:可复用的 UI 组件,提升开发效率 +- **工具函数 (utils/)**:封装常用的业务逻辑和数据处理函数 +- **静态资源 (images/, icons/)**:存放项目所需的图片和图标资源 +- **全局配置**:app.js(应用逻辑)、app.json(应用配置)、app.wxss(全局样式) #### 安装教程 -1. xxxx -2. xxxx -3. xxxx +1. **环境准备** + - 安装微信开发者工具(WeChat DevTools) + - 确保微信开发者工具版本支持当前项目要求 + +2. **下载项目** + - 通过 Git 克隆或下载本仓库代码到本地 + ```bash + git clone https://gitee.com/maple_8/app.git + ``` + +3. **导入项目** + - 打开微信开发者工具 + - 选择"导入项目",找到项目所在目录 + - 填写 AppID(可以使用测试号)或使用本地调试模式 + +4. **依赖安装** + - 如果项目涉及第三方 npm 包,请在微信开发者工具中点击"工具"->"构建 npm" #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +1. **启动应用** + - 导入项目后,点击微信开发者工具中的"编译"按钮即可预览 + +2. **功能操作** + - 首页:展示电力设备概览和实时数据 + - 设备管理:添加、删除、编辑电力设备 + - 详情查看:查看具体设备的详细参数和历史记录 + - 设置中心:配置报警阈值、通知方式等个性化选项 + +3. **调试预览** + - 使用真机预览功能扫码体验实际效果 + - 控制台可查看日志输出便于问题排查 #### 参与贡献 1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +2. 新建 Feat_xxx 分支(功能分支)或 Fix_xxx 分支(修复分支) +3. 提交代码时请确保代码规范,添加必要的注释 +4. 提交 Pull Request,等待代码审核 +5. 审核通过后合并到主分支 + +#### 注意事项 +- 请确保遵守微信小程序开发规范 +- 提交代码前请先拉取最新代码避免冲突 +- 敏感信息(如 API 密钥)请勿提交到仓库 -#### 特技 +#### 许可协议 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +本项目仅供学习交流使用,如需商业用途请联系原作者授权。 \ No newline at end of file