Merge pull request #32 from littlecxm/dev/readme

chore: readme

README.md

@@ -1,6 +1,5 @@
 <div id="top"></div>
 
-
 <!-- PROJECT SHIELDS -->
 [![Go Report Card][goreport-shield]][goreport-url]
 [![Forks][forks-shield]][forks-url]
@@ -28,9 +27,9 @@
   </p>
 </div>
 
+---
 
-
-## 1. 截图预览
+## 预览
 
 [![明色主题][product-light-screenshot]](https://www.paopao.info)
 
@@ -40,10 +39,7 @@
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- GETTING STARTED -->
-## 2. 快速开始
-
-### 2.1 技术栈
+## 🛠 技术栈
 
 PaoPao主要由以下优秀的开源项目/工具构建
 
@@ -54,22 +50,22 @@ PaoPao主要由以下优秀的开源项目/工具构建
 * [Vue.js](https://vuejs.org/)
 * [Vite.js](https://vitejs.dev/)
 
+<!-- GETTING STARTED -->
+## 🏗 快速开始
 
-### 2.2 环境要求
+### 环境要求
 
-- Go (1.17+)
-- Node.js (14+)
-- MySQL (5.7+)
-- Redis
-- Zinc
+* Go (1.17+)
+* Node.js (14+)
+* MySQL (5.7+)
+* Redis
+* Zinc
 
-\* Zinc是一款轻量级全文搜索引擎，可以查阅 https://zincsearch.com/ 安装
+\* Zinc是一款轻量级全文搜索引擎，可以查阅 <https://zincsearch.com/> 安装
 
 以上环境版本为PaoPao官方的开发版本，仅供参考，其他版本的环境未进行充分测试
 
-<br />
-
-### 3. 安装说明
+### 安装说明
 
 ***宝塔安装***
 
@@ -78,45 +74,62 @@ PaoPao主要由以下优秀的开源项目/工具构建
 ***普通安装***
 
 克隆代码库
+
    ```sh
    git clone https://github.com/rocboss/paopao-ce.git
    ```
-#### 3.1 后端
+
+#### 后端
 
 1. 导入项目根目录下的 `paopao.sql` 文件至MySQL数据库
 2. 拷贝项目根目录下 `config.yaml.sample` 文件至 `config.yaml`，按照注释完成配置编辑
 3. 编译后端
+
     ```sh
     go mod download
     go build -o paopao-api .
     ```
+
 4. 启动后端
+
     ```sh
     chmod +x paopao-api
     ./paopao-api
     ```
 
-#### 3.2 前端
+#### 前端
 
 1. 进入前端目录 `web`，编辑 `.env` 文件中后端服务地址，下载依赖包
+
     ```sh
     cd ./web
     vim .env
     yarn
     ```
+
 2. 编译前端
+
     ```sh
     yarn build
     ```
 
     build完成后，可以在dist目录获取编译产出，配置nginx指向至该目录即可
 
-#### 3.3 其他
-建议后端服务使用 `supervisor` 守护进程，并通过nginx反向代理后，提供API给前端服务调用。
+### 其他说明
+
+建议后端服务使用 `supervisor` 守护进程，并通过 `nginx` 反向代理后，提供API给前端服务调用。
+
+短信通道使用的[聚合数据](https://www.juhe.cn/)，如果申请不下来，可以考虑替换其他服务商。
+
+代码结构比较简单，很方便扩展
+
+## 👯‍♀️ 贡献
+
+喜欢的朋友欢迎给个Star、贡献PR。
 
-短信通道使用的聚合数据(juhe.cn)，如果申请不下来，可以考虑替换其他服务商。
+## License
 
-代码结构比较简单，很方便扩展，喜欢的朋友欢迎给个Star、贡献PR。
+Distributed under the MIT License. See `LICENSE` for more information.
 
 <!-- MARKDOWN LINKS & IMAGES -->
 [contributors-shield]: https://img.shields.io/github/contributors/rocboss/paopao-ce?style=flat