You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

106 lines
5.0 KiB

5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
  1. 
  2. <div align=center>
  3. <img src="http://qmplusimg.henrongyi.top/logo.png" width=300" height="300" />
  4. </div>
  5. <div align=center>
  6. <img src="https://img.shields.io/badge/vue-2.6.10-brightgreen"/>
  7. <img src="https://img.shields.io/badge/element--ui-2.12.0-green"/>
  8. <img src="https://img.shields.io/badge/golang-1.12-blue"/>
  9. <img src="https://img.shields.io/badge/gin-1.4.0-lightBlue"/>
  10. <img src="https://img.shields.io/badge/gorm-1.9.10-red"/>
  11. </div>
  12. # QMPlus gin+vue开源快速项目模板
  13. ## 写在前面
  14. 本项目主要是小弟在接各种私活的时候发现频繁得书写CURD、权限管理、用户管理、列表、分页、上传下载、日志包封装、文档自动化等等功能
  15. 为了方方便各位个人开发者快速搭建项目基础模型,于是开发本模板,也为了以后自己可以剩下一些初期开发的功夫
  16. 本身是前端出身,所以对于后端的项目目录或者架构可能偏向前端思维,如果有什么地方需要改动感谢大家iss
  17. 强烈希望在各位的帮助下,此项目可以用于企业级项目的开发
  18. ## 环境搭建教学视频
  19. <iframe frameborder="0" src="https://v.qq.com/txp/iframe/player.html?vid=c3008y2ukba" allowFullScreen="true"></iframe>
  20. 腾讯视频:https://v.qq.com/x/page/e3008xjxqtu.html
  21. ## 模板使用教学及展示视频
  22. <iframe frameborder="0" src="https://v.qq.com/txp/iframe/player.html?vid=c3008y2ukba" allowFullScreen="true"></iframe>
  23. 腾讯视频:https://v.qq.com/x/page/c3008y2ukba.html
  24. ## 技术选型
  25. 1.后端采用golang框架gin,快速搭建基础restful风格API
  26. 2.前端项目采用VUE框架,构建基础页面
  27. 3.数据库采用Mysql,可能会引用redis作为缓存数据库使用(待定)
  28. 4.使用swagger构建自动化文档
  29. 5.使用fsnotify和viper实现json格式配置文件
  30. 6.使用logrus实现日志记录
  31. 7.使用gorm实现对数据库的基本操作
  32. ## 项目说明
  33. golang项目存放于QMPlusServer文件夹下,内部config存放mysql相关配置。可以根据自己的mysql数据库名 用户名 密码修改对应配置
  34. vue项目存放于QMPlusVuePage文件夹下
  35. 开源不易,感谢各位支持,错误指出即刻改正,改写纠错,感谢star支持
  36. ## TODO
  37. 1.基本用户注册登录 √
  38. 2.用户等基础数据CURD √
  39. 3.调用des实现数据加密 √
  40. 4.实现基于jwt的权限管理
  41. 5.实现基于七牛云的文件上传操作(需提前注册七牛云账号) √(为了方便大家测试,我公开了自己的七牛测试号的各种重要token,恳请大家不要乱传东西)
  42. 6.等装了分页方法,实现分页接口并且复制粘贴就可使用分页 √
  43. 7.前端分页mixin封装 分页方法调用mixins即可 √
  44. 8...看项目进度想到什么做什么,主要目的是方便各位快速接私活,完成项目基础功能
  45. 9.各位开发者可以在issues提出自己工作中遇到的重复性大或者实现复杂的需求,我尽可能提供示例代码。
  46. ##计划任务
  47. 1.富文本编辑器,MarkFown编辑器功能嵌入
  48. 2.导入,导出Excel
  49. 3.Echart图表支持
  50. 4.object模式树
  51. 5.工作流,任务交接功能开发
  52. 6.结构体前端直接录入生成对应结构体及自动建表
  53. 7.单独前端使用模式以及数据模拟
  54. ## 使用说明
  55. 1.golang api server 基于go.mod 如果golang版本低于1.11 请自行升级golang版本
  56. 2.支持go.mod的golang版本在运行go list 和 编译之前都会自动下载所需要的依赖包
  57. 3.go server建议使用goland运行 减少出错可能性
  58. 4.前端项目node建议高于V8.6.0
  59. 5.到前端项目目录下运行 npm i 安装所需依赖
  60. 6.依赖安装完成直接运行 npm run dev即可启动项目
  61. 7.如果要使用swagger自动化文档 首先需要安装 swagger
  62. ````
  63. go get -u github.com/swaggo/swag/cmd/swag
  64. ````
  65. 由于国内没法安装到X包下面的东西 如果可以翻墙 上面的命令就可以让你安心使用swagger了
  66. 如果没有翻墙的办法那就先装一下 gopm
  67. ````
  68. go get -v -u github.com/gpmgo/gopm
  69. ````
  70. 此时你就可以使用 gopm了
  71. 这时候执行
  72. ````
  73. gopm get -g -v github.com/swaggo/swag/cmd/swag
  74. ````
  75. 等待安装完成以后
  76. 到我们GOPATH下面的/src/github.com/swaggo/swag/cmd/swag路径
  77. 执行
  78. ````
  79. go install
  80. ````
  81. 安装完成过后在项目目录下运行
  82. ````
  83. swag init
  84. ````
  85. 项目文件夹下面会有 doc文件夹出现
  86. 这时候登录 localhost:8888/swagger/index.html
  87. 就可以看到 swagger文档啦
  88. ## 个人博客
  89. http://www.henrongyi.top,内有前端框架教学视频,GOLANG基础入门视频正在筹备中。
  90. 如果觉得项目对您有所帮助可以添加我的个人微信:shouzi_1994,欢迎您提出宝贵的需求。
  91. ## 最后
  92. 正在研发前端独立版本分支...可以不依赖go服务进行使用的后台模板
  93. 感谢krank666协同开发
  94. 可使用的初始mysql脚本正在制作中...