initial docs

This commit is contained in:
zchengo
2022-11-28 16:37:13 +08:00
parent aececfe3e8
commit 61122aef6a
3 changed files with 117 additions and 0 deletions
+42
View File
@@ -0,0 +1,42 @@
### 目录结构
```
crm
├── doc // 项目文档
├── structure.md // 目录结构
├── techstack.md // 技术栈
├── server // 服务端
├── api // 接口层
├── common // 公共的方法
├── config // 配置文件映射的结构体
├── db // 数据库文件
├── global // 全局变量
├── initialize // 初始化运行环境
├── middleware // 中间件
├── models // 结构体
├── response // 响应结果封装
├── service // 服务层
├── config.yaml // 配置文件
├── go.mod // Go模块管理
├── go.sum // Go模块管理
├── main.go // 程序执行入口
├── web // Web端
├── public // 默认生成的
├── src // 源代码
├── api // 请求接口
├── assets // 静态资源
├── axios // 请求库封装
├── components // 组件
├── router // 页面路由
├── store // 状态管理
├── views // 页面
├── App.vue // 全局组件
├── main.js // 程序执行入口
├── index.html // 首页
├── package-lock.json // 依赖包
├── package.json // 依赖包
├── vite.config.js // Vite配置文件
├── .gitignore // Git文件忽略
├── LICENSE // 开源许可证
├── README.md // 项目文档
```
+23
View File
@@ -0,0 +1,23 @@
### 前端技术
| 技术 | 说明 | 相关文档 |
|---|---|---|
| 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 |