From 2e2b58e16538e4ad9946a5bd6e436c814f7b7917 Mon Sep 17 00:00:00 2001 From: xuecong Date: Mon, 17 Jan 2022 20:13:30 +0800 Subject: [PATCH] docs --- .gitattributes | 1 + .gitignore | 6 -- README.MD | 74 +++++++++--------- {resource => docs}/fake-open-wechat.MD | 0 {readme => docs/images}/agplv3.png | Bin {readme => docs/images}/chowa-qrcode.jpg | Bin {readme => docs/images}/logo.jpg | Bin {readme => docs/images}/oa-qrcode.jpg | Bin {readme => docs/images}/ower1.jpg | Bin {readme => docs/images}/ower2.jpg | Bin {readme => docs/images}/ower3.jpg | Bin {readme => docs/images}/ower4.jpg | Bin {readme => docs/images}/ower5.jpg | Bin {readme => docs/images}/ower6.jpg | Bin {readme => docs/images}/ower7.jpg | Bin {readme => docs/images}/ower8.jpg | Bin {readme => docs/images}/pc1.jpg | Bin {readme => docs/images}/pc2.jpg | Bin {readme => docs/images}/pc3.jpg | Bin {readme => docs/images}/pc4.jpg | Bin {readme => docs/images}/pc5.jpg | Bin {readme => docs/images}/pmp-qrcode.jpg | Bin {readme => docs/images}/qq.jpg | Bin {readme => docs/images}/ump-qrcode.jpg | Bin {readme => docs/images}/web1.png | Bin {readme => docs/images}/web10.jpg | Bin {readme => docs/images}/web11.jpg | Bin {readme => docs/images}/web2.jpg | Bin {readme => docs/images}/web3.jpg | Bin {readme => docs/images}/web4.jpg | Bin {readme => docs/images}/web5.jpg | Bin {readme => docs/images}/web6.jpg | Bin {readme => docs/images}/web7.jpg | Bin {readme => docs/images}/web8.jpg | Bin {readme => docs/images}/web9.jpg | Bin {readme => docs/images}/wechat-group.jpg | Bin iot/README.MD => docs/iot.MD | 2 +- {readme => docs}/ip.MD | 0 oa/README.MD => docs/oa.MD | 0 {resource => docs/resource}/db.sql | 0 {resource => docs/resource}/default.png | Bin .../resource}/manual_employee.pdf | Bin {resource => docs/resource}/manual_ower.pdf | Bin {resource => docs/resource}/manual_web.pdf | Bin .../resource}/固定资产导入模板.xlsx | Bin sms/README.MD => docs/sms.MD | 0 resource/README.MD => docs/start.MD | 2 +- iot/.gitkeep | 0 48 files changed, 40 insertions(+), 45 deletions(-) rename {resource => docs}/fake-open-wechat.MD (100%) rename {readme => docs/images}/agplv3.png (100%) rename {readme => docs/images}/chowa-qrcode.jpg (100%) rename {readme => docs/images}/logo.jpg (100%) rename {readme => docs/images}/oa-qrcode.jpg (100%) rename {readme => docs/images}/ower1.jpg (100%) rename {readme => docs/images}/ower2.jpg (100%) rename {readme => docs/images}/ower3.jpg (100%) rename {readme => docs/images}/ower4.jpg (100%) rename {readme => docs/images}/ower5.jpg (100%) rename {readme => docs/images}/ower6.jpg (100%) rename {readme => docs/images}/ower7.jpg (100%) rename {readme => docs/images}/ower8.jpg (100%) rename {readme => docs/images}/pc1.jpg (100%) rename {readme => docs/images}/pc2.jpg (100%) rename {readme => docs/images}/pc3.jpg (100%) rename {readme => docs/images}/pc4.jpg (100%) rename {readme => docs/images}/pc5.jpg (100%) rename {readme => docs/images}/pmp-qrcode.jpg (100%) rename {readme => docs/images}/qq.jpg (100%) rename {readme => docs/images}/ump-qrcode.jpg (100%) rename {readme => docs/images}/web1.png (100%) rename {readme => docs/images}/web10.jpg (100%) rename {readme => docs/images}/web11.jpg (100%) rename {readme => docs/images}/web2.jpg (100%) rename {readme => docs/images}/web3.jpg (100%) rename {readme => docs/images}/web4.jpg (100%) rename {readme => docs/images}/web5.jpg (100%) rename {readme => docs/images}/web6.jpg (100%) rename {readme => docs/images}/web7.jpg (100%) rename {readme => docs/images}/web8.jpg (100%) rename {readme => docs/images}/web9.jpg (100%) rename {readme => docs/images}/wechat-group.jpg (100%) rename iot/README.MD => docs/iot.MD (83%) rename {readme => docs}/ip.MD (100%) rename oa/README.MD => docs/oa.MD (100%) rename {resource => docs/resource}/db.sql (100%) rename {resource => docs/resource}/default.png (100%) rename {resource => docs/resource}/manual_employee.pdf (100%) rename {resource => docs/resource}/manual_ower.pdf (100%) rename {resource => docs/resource}/manual_web.pdf (100%) rename {resource => docs/resource}/固定资产导入模板.xlsx (100%) rename sms/README.MD => docs/sms.MD (100%) rename resource/README.MD => docs/start.MD (94%) delete mode 100644 iot/.gitkeep diff --git a/.gitattributes b/.gitattributes index 282f21f..2eb0392 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1,2 @@ *.js linguist-language=TypeScript +*.css linguist-language=less diff --git a/.gitignore b/.gitignore index b0877db..533b3f9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,5 @@ *.log npm-debug.log* -yarn-debug.log* -yarn-error.log* -pids -*.pid -*.seed -*.pid.lock node_modules/ .npm dist diff --git a/README.MD b/README.MD index e28abc8..eeef73b 100644 --- a/README.MD +++ b/README.MD @@ -1,4 +1,4 @@ -![logo](readme/logo.jpg) +![logo](docs/images/logo.jpg) ## 项目介绍 @@ -8,39 +8,39 @@ ### web中台 -![web1](readme/web1.png) -![web2](readme/web2.jpg) -![web3](readme/web3.jpg) -![web4](readme/web4.jpg) -![web5](readme/web5.jpg) -![web6](readme/web6.jpg) -![web7](readme/web7.jpg) -![web8](readme/web8.jpg) -![web9](readme/web9.jpg) -![web10](readme/web10.jpg) -![web11](readme/web11.jpg) +![web1](docs/images/web1.png) +![web2](docs/images/web2.jpg) +![web3](docs/images/web3.jpg) +![web4](docs/images/web4.jpg) +![web5](docs/images/web5.jpg) +![web6](docs/images/web6.jpg) +![web7](docs/images/web7.jpg) +![web8](docs/images/web8.jpg) +![web9](docs/images/web9.jpg) +![web10](docs/images/web10.jpg) +![web11](docs/images/web11.jpg) ### 业主端小程序

- - - - - - - - + + + + + + + +

### 员工端小程序

- - - - - + + + + +

## 技术亮点 @@ -73,7 +73,7 @@ 如果你想有一个自己的账号体验系统、给别人演示，登录后可以在【协同办公】->【人力资源】-> 【员工入职】中自己开通一个，开通后，你就可以通过自己的微信扫码登录中台了~也可以用自己的微信访问【物业员工小程序】了。 - + | :warning: 注意 | | --------------------------- | @@ -82,24 +82,24 @@ | 不要在体验环境中发垃圾信息！尤其是一串随意敲打的英文和数字！！！ | | 请勿在环境中添加、发布不良信息！发布不良信息会封IP | -> 如果无法访问，请查看是否被封了IP，[封禁IP列表](readme/ip.MD) +> 如果无法访问，请查看是否被封了IP，[封禁IP列表](docs/ip.MD) ### 业主小程序 - + ### 物业员工小程序 > 访问员工小程序需要将自己的微信和账号关联的。登录web中台后在【协同办公】->【人力资源】-> 【员工入职】中自己开通一个账号即可体验。 - + ### 微信公众号 > 对于业主主要是为了群发和单点通知；对于物业公司员工是为了提供工单、流程通知 - + ## 如何部署 @@ -114,14 +114,14 @@ > 认真仔细看文档，会少走很多弯路 -- [部署前的准备](resource/README.MD) +- [部署前的准备](docs/start.MD) - [服务端部署](server/README.MD) - [web端部署](web/README.MD) - [业主端小程序](ower-mp/README.MD) - [员工端小程序](employee-mp/README.MD) -- [公众号模板消息](oa/README.MD) -- [短信消息模板](sms/README.MD) -- [小区硬件接入](iot/README.MD) +- [公众号模板消息](docs/oa.MD) +- [短信消息模板](docs/sms.MD) +- [小区硬件接入](docs/iot.MD) ## 交流 @@ -131,7 +131,7 @@ ### QQ交流群

- +

### 微信交流群 @@ -139,7 +139,7 @@ > 由于微信群二维码有时效性，所以请添加这个小号微信，小号会拉你入群，添加时请备注“e家宜业”。

- +

## 参与开发 @@ -154,4 +154,4 @@ ## License -![AGPL](readme/agplv3.png) +![AGPL](docs/images/agplv3.png) diff --git a/resource/fake-open-wechat.MD b/docs/fake-open-wechat.MD similarity index 100% rename from resource/fake-open-wechat.MD rename to docs/fake-open-wechat.MD diff --git a/readme/agplv3.png b/docs/images/agplv3.png similarity index 100% rename from readme/agplv3.png rename to docs/images/agplv3.png diff --git a/readme/chowa-qrcode.jpg b/docs/images/chowa-qrcode.jpg similarity index 100% rename from readme/chowa-qrcode.jpg rename to docs/images/chowa-qrcode.jpg diff --git a/readme/logo.jpg b/docs/images/logo.jpg similarity index 100% rename from readme/logo.jpg rename to docs/images/logo.jpg diff --git a/readme/oa-qrcode.jpg b/docs/images/oa-qrcode.jpg similarity index 100% rename from readme/oa-qrcode.jpg rename to docs/images/oa-qrcode.jpg diff --git a/readme/ower1.jpg b/docs/images/ower1.jpg similarity index 100% rename from readme/ower1.jpg rename to docs/images/ower1.jpg diff --git a/readme/ower2.jpg b/docs/images/ower2.jpg similarity index 100% rename from readme/ower2.jpg rename to docs/images/ower2.jpg diff --git a/readme/ower3.jpg b/docs/images/ower3.jpg similarity index 100% rename from readme/ower3.jpg rename to docs/images/ower3.jpg diff --git a/readme/ower4.jpg b/docs/images/ower4.jpg similarity index 100% rename from readme/ower4.jpg rename to docs/images/ower4.jpg diff --git a/readme/ower5.jpg b/docs/images/ower5.jpg similarity index 100% rename from readme/ower5.jpg rename to docs/images/ower5.jpg diff --git a/readme/ower6.jpg b/docs/images/ower6.jpg similarity index 100% rename from readme/ower6.jpg rename to docs/images/ower6.jpg diff --git a/readme/ower7.jpg b/docs/images/ower7.jpg similarity index 100% rename from readme/ower7.jpg rename to docs/images/ower7.jpg diff --git a/readme/ower8.jpg b/docs/images/ower8.jpg similarity index 100% rename from readme/ower8.jpg rename to docs/images/ower8.jpg diff --git a/readme/pc1.jpg b/docs/images/pc1.jpg similarity index 100% rename from readme/pc1.jpg rename to docs/images/pc1.jpg diff --git a/readme/pc2.jpg b/docs/images/pc2.jpg similarity index 100% rename from readme/pc2.jpg rename to docs/images/pc2.jpg diff --git a/readme/pc3.jpg b/docs/images/pc3.jpg similarity index 100% rename from readme/pc3.jpg rename to docs/images/pc3.jpg diff --git a/readme/pc4.jpg b/docs/images/pc4.jpg similarity index 100% rename from readme/pc4.jpg rename to docs/images/pc4.jpg diff --git a/readme/pc5.jpg b/docs/images/pc5.jpg similarity index 100% rename from readme/pc5.jpg rename to docs/images/pc5.jpg diff --git a/readme/pmp-qrcode.jpg b/docs/images/pmp-qrcode.jpg similarity index 100% rename from readme/pmp-qrcode.jpg rename to docs/images/pmp-qrcode.jpg diff --git a/readme/qq.jpg b/docs/images/qq.jpg similarity index 100% rename from readme/qq.jpg rename to docs/images/qq.jpg diff --git a/readme/ump-qrcode.jpg b/docs/images/ump-qrcode.jpg similarity index 100% rename from readme/ump-qrcode.jpg rename to docs/images/ump-qrcode.jpg diff --git a/readme/web1.png b/docs/images/web1.png similarity index 100% rename from readme/web1.png rename to docs/images/web1.png diff --git a/readme/web10.jpg b/docs/images/web10.jpg similarity index 100% rename from readme/web10.jpg rename to docs/images/web10.jpg diff --git a/readme/web11.jpg b/docs/images/web11.jpg similarity index 100% rename from readme/web11.jpg rename to docs/images/web11.jpg diff --git a/readme/web2.jpg b/docs/images/web2.jpg similarity index 100% rename from readme/web2.jpg rename to docs/images/web2.jpg diff --git a/readme/web3.jpg b/docs/images/web3.jpg similarity index 100% rename from readme/web3.jpg rename to docs/images/web3.jpg diff --git a/readme/web4.jpg b/docs/images/web4.jpg similarity index 100% rename from readme/web4.jpg rename to docs/images/web4.jpg diff --git a/readme/web5.jpg b/docs/images/web5.jpg similarity index 100% rename from readme/web5.jpg rename to docs/images/web5.jpg diff --git a/readme/web6.jpg b/docs/images/web6.jpg similarity index 100% rename from readme/web6.jpg rename to docs/images/web6.jpg diff --git a/readme/web7.jpg b/docs/images/web7.jpg similarity index 100% rename from readme/web7.jpg rename to docs/images/web7.jpg diff --git a/readme/web8.jpg b/docs/images/web8.jpg similarity index 100% rename from readme/web8.jpg rename to docs/images/web8.jpg diff --git a/readme/web9.jpg b/docs/images/web9.jpg similarity index 100% rename from readme/web9.jpg rename to docs/images/web9.jpg diff --git a/readme/wechat-group.jpg b/docs/images/wechat-group.jpg similarity index 100% rename from readme/wechat-group.jpg rename to docs/images/wechat-group.jpg diff --git a/iot/README.MD b/docs/iot.MD similarity index 83% rename from iot/README.MD rename to docs/iot.MD index 21636b8..57ee9b7 100644 --- a/iot/README.MD +++ b/docs/iot.MD @@ -1,6 +1,6 @@ ## 「e家宜业」物联网服务端 -> 代码整理中，敬请期待 +> 物联网硬件对接没有统一标准，此部分仅作参考，有能力的同学和企业可自行拆分、对接开发。 ### 智能门禁 diff --git a/readme/ip.MD b/docs/ip.MD similarity index 100% rename from readme/ip.MD rename to docs/ip.MD diff --git a/oa/README.MD b/docs/oa.MD similarity index 100% rename from oa/README.MD rename to docs/oa.MD diff --git a/resource/db.sql b/docs/resource/db.sql similarity index 100% rename from resource/db.sql rename to docs/resource/db.sql diff --git a/resource/default.png b/docs/resource/default.png similarity index 100% rename from resource/default.png rename to docs/resource/default.png diff --git a/resource/manual_employee.pdf b/docs/resource/manual_employee.pdf similarity index 100% rename from resource/manual_employee.pdf rename to docs/resource/manual_employee.pdf diff --git a/resource/manual_ower.pdf b/docs/resource/manual_ower.pdf similarity index 100% rename from resource/manual_ower.pdf rename to docs/resource/manual_ower.pdf diff --git a/resource/manual_web.pdf b/docs/resource/manual_web.pdf similarity index 100% rename from resource/manual_web.pdf rename to docs/resource/manual_web.pdf diff --git a/resource/固定资产导入模板.xlsx b/docs/resource/固定资产导入模板.xlsx similarity index 100% rename from resource/固定资产导入模板.xlsx rename to docs/resource/固定资产导入模板.xlsx diff --git a/sms/README.MD b/docs/sms.MD similarity index 100% rename from sms/README.MD rename to docs/sms.MD diff --git a/resource/README.MD b/docs/start.MD similarity index 94% rename from resource/README.MD rename to docs/start.MD index 3f55d48..b10cd21 100644 --- a/resource/README.MD +++ b/docs/start.MD @@ -1,7 +1,7 @@ ## 前言 -我们开源的目的是为了交流和学习。希望你能够认真阅读本文档后在决定用不用！ +这是一整套涉及到前后端知识、微信生态以及物联网应用的系统应用！我们开源的目的是为了交流和学习。希望你能够认真阅读本文档后在决定用不用！ 如果你连开源都不知道是什么，我建议你还是不要看了，关了文档打会游戏去吧！ diff --git a/iot/.gitkeep b/iot/.gitkeep deleted file mode 100644 index e69de29..0000000