From 8a04a0bf192dc7e6d4d9b83e53a6feac29f125f4 Mon Sep 17 00:00:00 2001
From: fanxb <fleyx20@outlook.com>
Date: Wed, 2 Mar 2022 15:52:04 +0800
Subject: [PATCH] =?UTF-8?q?docs:=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                                   | 49 +++++++++++++++++++++
 deploy.md                                   |  7 +++
 qiezi_front/public/index.html               | 18 +++++---
 qiezi_front/public/indexResource/index.html | 40 +++++++++--------
 4 files changed, 88 insertions(+), 26 deletions(-)
 create mode 100644 README.md
 create mode 100644 deploy.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..580858f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+本应用是一款轻量级的 UV/PV 流量计数器，可用于各种网站流量统计，支持直接使用以及私有部署使用。
+
+# 快速开始
+
+## 获取 key/secret
+
+1. 直接使用
+
+   点击[应用注册](https://qiezi.fleyx.com/manage/#/application/sign),填写域名信息及验证码获取 key 和 secret
+   ![应用注册](https://qiniupic.fleyx.com/blog/202203021523359.png)
+
+2. 私有部署
+
+   参考[部署文档]()，进行服务部署.
+
+   部署完毕后，同样进行应用注册获取 key 和 secret,只是这种情况下是访问你自己的部署环境进行应用注册
+
+## 添加 html 代码段
+
+到这一步假设你已经获取了 key 和 secret
+
+通过如下代码，可添加页面独立 PV 和网站整体 UV/PV
+
+```html
+<!-- 页面PV -->
+<div style="text-align: center;">
+  <div id="qieziStatisticHtmlPost" style="display: none;">当前页面访问次数:<span id="qieziStatisticHtmlPostPv"></span>次&nbsp;</div>
+</div>
+<!-- 网站整体UV/PV -->
+<div style="text-align: center;">
+  <div id="qieziStatisticHtmlHostPv" style="display: none;">总访问次数:<span id="qieziStatisticHtmlHostPvValue"></span>次&nbsp;</div>
+  <div id="qieziStatisticHtmlHostUv" style="display: none;">&nbsp;总访客数:<span id="qieziStatisticHtmlHostUvValue"></span>人</div>
+</div>
+<script>
+  //如果私有部署才需要填写此项，设置为你的私有部署地址
+  //window.qieziStatisticHost = "http://localhost:8080";
+  //设置上一节获取到的key
+  window.qieziStatisticKey = "d862c12a68ad4d579c6066ac2f064a07";
+</script>
+<script src="/qiezijs/1.0/qiezi_statistic.min.js" type="text/javascript"></script>
+```
+
+效果如下：
+
+![效果图](https://qiniupic.fleyx.com/blog/202203021545574.png)
+
+## 定制化样式
+
+上面的 html 代码段只是简单的使用实例，可自行定制化样式，只需要保持存在上述**id**存在即可.
diff --git a/deploy.md b/deploy.md
new file mode 100644
index 0000000..ab305ed
--- /dev/null
+++ b/deploy.md
@@ -0,0 +1,7 @@
+# docker-compose 部署
+
+1. 首先安装 docker 和 docker-compose
+2. 修改.env 文件，配置 mysql，redis 地址，以及访问端口
+3. 执行`build.sh`,进行编译
+4. 执行`docker-compose up -d`启动服务，启动完毕后通过服务器 ip+第二部配置的访问端口进行访问
+5. 更新代码时先执行`build.sh`,再执行`docker-compose restart`重启服务
diff --git a/qiezi_front/public/index.html b/qiezi_front/public/index.html
index 959c3b1..53acd56 100644
--- a/qiezi_front/public/index.html
+++ b/qiezi_front/public/index.html
@@ -17,15 +17,19 @@
 
     <div id="app"></div>
 
-    <!-- built files will be auto injected -->
-    <div style="text-align: center;">
-        <div id="qieziStatisticHtmlHostPv" style="display: none;">页面访问次数:<span id="qieziStatisticHtmlHostPvValue"></span>次&nbsp;</div>
-        <div id="qieziStatisticHtmlHostUv" style="display: none;">&nbsp;总访客数:<span id="qieziStatisticHtmlHostUvValue"></span>人</div>
+    <!-- 页面PV -->
+    <div style="text-align: center">
+      <div id="qieziStatisticHtmlPost" style="display: none">当前页面访问次数:<span id="qieziStatisticHtmlPostPv"></span>次&nbsp;</div>
+    </div>
+    <!-- 网站整体UV/PV -->
+    <div style="text-align: center">
+      <div id="qieziStatisticHtmlHostPv" style="display: none">总访问次数:<span id="qieziStatisticHtmlHostPvValue"></span>次&nbsp;</div>
+      <div id="qieziStatisticHtmlHostUv" style="display: none">&nbsp;总访客数:<span id="qieziStatisticHtmlHostUvValue"></span>人</div>
     </div>
     <script>
-        //设置实际部署的host和key
-        window.qieziStatisticHost="http://localhost:8080";
-        window.qieziStatisticKey="d862c12a68ad4d579c6066ac2f064a07";
+      //设置实际部署的host和key
+      window.qieziStatisticHost = "http://localhost:8080";
+      window.qieziStatisticKey = "d862c12a68ad4d579c6066ac2f064a07";
     </script>
     <script src="/qiezijs/1.0/qiezi_statistic.js" type="text/javascript"></script>
   </body>
diff --git a/qiezi_front/public/indexResource/index.html b/qiezi_front/public/indexResource/index.html
index ee16a3a..58b6ec4 100644
--- a/qiezi_front/public/indexResource/index.html
+++ b/qiezi_front/public/indexResource/index.html
@@ -8,26 +8,28 @@
     <title>茄子统计</title>
   </head>
   <body>
-    <div class="app">
-		免费UV,PV统计，可自行部署，也可直接使用。使用文档见：<a href="/manage/">开始使用</a>
-	</div>
-    <div style="text-align: center;">
-      <div id="qieziStatisticHtmlHostPv" style="display: none;">页面访问次数:<span id="qieziStatisticHtmlHostPvValue"></span>次&nbsp;</div>
-      <div id="qieziStatisticHtmlHostUv" style="display: none;">&nbsp;总访客数:<span id="qieziStatisticHtmlHostUvValue"></span>人</div>
+    <div class="app">免费UV,PV统计，可自行部署，也可直接使用。使用文档见：<a href="/manage/">开始使用</a></div>
+    <!-- 页面PV -->
+    <div style="text-align: center">
+      <div id="qieziStatisticHtmlPost" style="display: none">当前页面访问次数:<span id="qieziStatisticHtmlPostPv"></span>次&nbsp;</div>
     </div>
-	<script>
-		//设置实际部署的host和key
-		window.qieziStatisticHost="http://localhost:8080";
-		window.qieziStatisticKey="d862c12a68ad4d579c6066ac2f064a07";
-	</script>
+    <!-- 网站整体UV/PV -->
+    <div style="text-align: center">
+      <div id="qieziStatisticHtmlHostPv" style="display: none">总访问次数:<span id="qieziStatisticHtmlHostPvValue"></span>次&nbsp;</div>
+      <div id="qieziStatisticHtmlHostUv" style="display: none">&nbsp;总访客数:<span id="qieziStatisticHtmlHostUvValue"></span>人</div>
+    </div>
+    <script>
+      //设置实际部署的host和key
+      window.qieziStatisticHost = "http://localhost:8080";
+      window.qieziStatisticKey = "d862c12a68ad4d579c6066ac2f064a07";
+    </script>
     <script src="/qiezijs/1.0/qiezi_statistic.js" type="text/javascript"></script>
-	<style>
-		.app{
-			width:80%;
-			margin: 0 auto;
-			text-align: center;
-		}
-	</style>
-	
+    <style>
+      .app {
+        width: 80%;
+        margin: 0 auto;
+        text-align: center;
+      }
+    </style>
   </body>
 </html>