docs: change and add docs

This commit is contained in:
zchengo
2023-01-15 18:29:31 +08:00
parent 84a105a3d8
commit 74fcfedaec
41 changed files with 1706 additions and 316 deletions
+24 -38
View File
@@ -1,43 +1,26 @@
# crm
<a href="#公众号"><img src="https://img.shields.io/badge/公众号-GoCode-%2302DF6D" /></a>
<a href="https://zocrm.cloud"><img src="https://img.shields.io/badge/官网-zocrm.cloud-%230092FF" /></a>
<div style="text-align: center;">
## 项目简介
<img src="https://docs.zocrm.cloud/logo.svg" style="width: 150px;height: 150px;filter: drop-shadow(2px 2px 6px #79bbff);"/>
<p>一个免费、开源的客户关系管理系统。</p>
<a href="#公众号"><img src="https://img.shields.io/badge/公众号-GoCode-%2302DF6D" /></a>
<a href="https://zocrm.cloud"><img src="https://img.shields.io/badge/在线演示-zocrm.cloud-%230092FF" /></a>
<a href="https://docs.zocrm.cloud"><img src="https://img.shields.io/badge/项目文档-docs.zocrm.cloud-%230092FF" /></a>
</div>
## 简介
客户关系管理系统,基于 Vue + Go 实现,主要功能有仪表盘、客户管理、合同管理、产品管理,订阅等功能。
在线演示:https://zocrm.cloud
- 在线演示:[zocrm.cloud](https://zocrm.cloud)
开发文档:https://docs.zocrm.cloud
- 项目文档:[docs.zocrm.cloud](https://docs.zocrm.cloud)
## 技术选型
### 前端技术
| 技术 | 说明 | 相关文档 |
|---|---|---|
| Vue.js | 前端框架 | https://v3.cn.vuejs.org |
| Vue Router | 页面路由 | https://router.vuejs.org |
| Axios | 网络请求库 | https://axios-http.com |
| Pinia | 状态管理 | https://pinia.vuejs.org |
| Vite | 构建工具 | https://vitejs.cn |
| Ant Design Vue | 前端UI组件库 | https://www.antdv.com |
| Apache ECharts | 可视化图表库 | https://echarts.apache.org |
| Moment | 日期库 | https://momentjs.com |
### 后端技术
| 技术 | 说明 | 相关文档 |
|---|---|---|
| Gin | Web框架 | https://gin-gonic.com |
| Gorm | ORM框架 | https://gorm.io |
| Jwt | 用户认证 | https://github.com/golang-jwt/jwt |
| Viper | 配置管理 | https://github.com/spf13/viper |
| Redis | 数据缓存 | https://github.com/go-redis/redis |
| Mail | 邮件服务SDK | https://github.com/go-gomail/gomail |
## 快速运行
## 快速开始
系统运行环境:
@@ -48,10 +31,9 @@
| redis | >= 7.0.5 | https://redis.io/download |
| node | >= 18.12.0 | https://nodejs.org/en/download |
在终端中,执行如下命令:
在终端中,执行如下命令,初始化并运行。
```
```bash
$ cd server
$ go mod tidy
$ go build -o server main.go (windows编译命令为 go build -o server.exe main.go )
@@ -64,13 +46,17 @@ $ npm install
$ npm run dev
```
项目运行成功后,打开浏览器访问 http://127.0.0.1:8060
初始化和启动成功后,打开浏览器访问[http://127.0.0.1:8060](http://127.0.0.1:8060)。
## 项目文档
想要了解有关项目的更多信息,请访问[docs.zocrm.cloud](https://docs.zocrm.cloud)。
## 公众号
关注公众号「**GoCode**」,回复「**部署指南**」,获取详细部署指南
欢迎关注公众号「GoCode」,本公众号专注Go语言技术分享
![公众号图片](https://zocrm.cloud/gzh_qrcode.jpg)
![公众号图片](https://docs.zocrm.cloud/gzh_qrcode.jpg)
## 许可证