Skip to content

Commit 662aa78

Browse files
committed
更新文档
1 parent 09fb576 commit 662aa78

File tree

5 files changed

+136
-170
lines changed

5 files changed

+136
-170
lines changed

README.md

Lines changed: 89 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -2,133 +2,126 @@
22
2018年的春节假期,受朋友的鼓励和内心的指引,对近两年所学到的知识进行了系统的沉淀和总结。
33
从多个项目中提取关键点、抛弃了的业务部分,对底层的功能进行了各类优化和抽象,写成本项目。
44
## 1、 当前版本介绍
5-
### 1.1 版本说明
5+
6+
## 1.1 版本说明
7+
68
> 当前版本laravel_template_with_vue (3)
7-
>
8-
> ### 1.2 改进说明
9-
10-
> #### 总体构架
9+
10+
## 1.2 改进说明
11+
12+
#### 总体构架
1113
> 1. 修改后端目录为api
12-
> 2。修改前端目录为admin_element(UI使用element) admin_antd(UI使用antd)
13-
> 3. 增加小程序端目录uni-app(UI使用uview)
14-
> 4、增加独立的公众号wx_vant目录(单页面 UI使用vant)
14+
> 2. 修改管理端目录为element(UI使用element)
15+
> 3. 增加管理端目录antd(UI使用antd)
16+
> 4. 增加小程序端目录uni-app(UI使用uview)
17+
> 5. 增加独立的公众号目录vant(单页面 UI使用vant)
1518
1619
#### 后端:
1720
> 1.更新larave框架为LTS版本laravel6
21+
>
1822
> 2.更新passport插件到最新版本
23+
>
24+
> 3.完善RBAC管理
25+
>
26+
> 4.增加验证码功能、短信发送功能和第三方登陆等功能
27+
28+
#### 管理端:
29+
> 1. 前端element ui 更新到了2.15.6版本,请参照开发
30+
> 2. 完善RBAC的管理端操作
31+
> 3. 增加简单的内容管理(文章、文章类型、轮播图,使用于小程序和公众号等)
32+
> 6. 配置完善websocket功能,实现聊天室、客服等功能
33+
> 7. 增加微信端的各种配置信息等
1934
20-
#### 前端:
21-
> 1. 前端element ui 更新到了2.7.2版本,请参照开发
22-
> 2. 集成了同时打开多个页面的功能,多标签功能
23-
> 3. 集成了全屏操作的功能
24-
> 4. 增加了日志管理功能
25-
> 5. 增加了前端开发示列,商品订单管理,代码层面利用mixin功能优化书写
26-
> 6. 接收后端推送的消息,强制下线多次登陆的用户,保证同一个用户在什么时间与地点只能登陆一次。
27-
> 7. 增加了应用事例模块,把具有代表性的聊天室功能和客服功能集成到项目中
35+
#### 小程序端:
2836

29-
#### ToDo:
30-
> 1. 前端增加用户多角色动态切换功能
31-
> 2. 增加成员管理功能,实现微信登录、qq登录等第三方用户登录的功能
32-
> 3. 增加成员注册和使用功能
37+
> 1. 小程序完善的目录结构和开发功能,直接对接后端接口
38+
>
39+
> 2. 小程序内用户的登陆、获取用户名和手机号码
3340
3441
## 2、系统概述
35-
项目依托laravel5.5与vue.js,采用了主流的前后端分离方式来构建,作为程序的起点,你可以在此基础上进行自身业务的扩展。
36-
后端(backend目录)负责OAuth认证、用户授权、第三方用户登录验证和提供API,在此基础上集成了跨域和excel文件的操作等基础功能,使用者只需专注于业务api的开发即可。
37-
后端(backend目录)整合了laravel-echo-server,实现了websocket。用于消息的实时推送、聊天室、客服等功能,是全网最好的laravel-echo-server教程。
38-
前端(frontend目录)负责页面的显示和前端用户权限的控制。项目已经引入了element UI框架,并已经对用户登录认证、路由、权限等基础功能进行了处理。
39-
前端用户的权限不但可以控制系统的导航菜单,而且可以控制到页面按钮、表格等内容的显示。使用者只需要专注于业务界面的开发即可。
42+
项目依托laravel6与vue.js,采用了主流的前后端分离方式来构建,作为程序的起点,你可以在此基础上进行自身业务的扩展。
43+
后端(api目录)负责OAuth认证、用户授权、第三方用户登录验证和提供API,在此基础上集成excel文件的操作和完善的RBAC管理等基础功能,使用者只需专注于业务api的开发即可。后端整合了laravel-echo-server,实现了websocket。并实现消息的实时推送、为聊天室、客服等功能提供了API,是全网最好的laravel-echo-server教程。
44+
前端(element目录)负责页面的显示和前端用户权限的控制。项目引入了element UI框架,并已经对用户登录认证、路由、权限等基础功能进行了处理。前端用户的权限不但可以控制系统的导航菜单,而且可以控制到页面按钮、表格等内容的显示。使用者只需要专注于业务界面的开发即可。
45+
小程序(uni-app目录)主要用户小程序开发,集成了uview,实现了用户的登陆授权和获取手机号等功能,在此基础上,使用时只需要关心业务页面的开发即可以。
4046
本项目使用广泛,已经在本人的多个项目中商用。
41-
> 第三方登录测试时,可以先进入系统创建一个用户,然后用github登录后绑定刚刚创建的新用户,之后就可以使用github来自动登录了(可以参考版本1,版本2因为项目调整的关系,之后才会增加)
47+
#### 注意事项
48+
49+
> 1. 系统中admin用户为超级管理员,为了方便演示,也是为了供大家使用,发布的版本中,已经屏蔽admin用户的信息修改等功能,实际开发中,用户只需要去相应的前端页面中学校除去屏蔽修改的语句就可以。
50+
>
51+
> 2. 为了使用websocket等功能,需要用户同时修改前后和后端的配置,开启websocket
52+
>
53+
> ​ 3. 为了演示聊天室和客服等功能,用户可以进入系统后首先创建多个用户,并且利用不同的浏览器同时登陆,就可以演示相关功能。
4254
4355
## 3、项目演示与截图
44-
> [element-ui](https://github.com/wmhello/laravel_template_with_vue.git)演示网站(http://vue.ouenyione.com)
45-
> [antd-for-vue](https://github.com/wmhello/antd_and_html5.git) 演示网站(http://wmhello.wicp.vip)
46-
> 管理员用户名和密码([email protected]/123456)
47-
> 普通用户用户名和密码([email protected]/123456)
56+
> (管理端 element ui)演示网站(http://elem.halian.net)
57+
>
58+
> 管理员用户名和密码(admin/123456)
4859
4960
### 项目截图
50-
#### 文档
51-
![系统文档](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/doc.png)
52-
53-
#### 登陆页面(随机选择登陆页面)
54-
![](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/login.png)
55-
![](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/login2.png)
61+
#### 登陆页面(可以扩充到使用验证码和手机号码登陆)
62+
![登陆页面]()
5663

57-
#### 聊天室
5864

59-
![聊天室](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/chat.png)
6065

61-
#### 客服(普通用户界面 1对1)
62-
![客服界面1](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/kefu-user.png)
66+
管理员面板
6367

64-
#### 客服(客服界面 1对多)
65-
![客服界面2](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/kefu-service.png)
66-
67-
#### 管理员面板
68-
![管理员面板](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-admin-dashboard.png)
69-
70-
#### 普通用户面板[注意观察系统日志和左侧导航菜单]
71-
![普通用户面板](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-user-dashboard.png)
68+
![管理员面板]()
7269

7370
#### 修改个人信息
74-
![修改个人信息](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-modify-info.png)
71+
![修改个人信息]()
7572

7673
#### 全屏幕操作
77-
![全屏幕操作](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-full-screen.png)
74+
![全屏幕操作]()
7875

79-
#### 用户管理
80-
![用户管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-user-list.png)
76+
#### 管理员管理
77+
![用户管理]()
8178

82-
#### 用户添加
83-
![用户添加](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-user-add.png)
79+
#### 添加管理员
80+
![用户添加]()
8481

85-
#### 用户数据导出
86-
![用户数据导出](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-user-download.png)
82+
#### 导入管理员
83+
![导入管理员]()
8784

8885
#### 角色管理
89-
![角色管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-role-manger.png)
86+
![角色管理]()
9087

9188
#### 角色功能设置
92-
![角色功能设置](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-role-set-feature.png)
89+
![角色功能设置]()
90+
91+
#### 模块与权限管理
92+
![模块管理]()
9393

94-
#### 功能管理
95-
![功能管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-permission-manger.png)
94+
#### 添加新模块
95+
![添加新模块]()
9696

97-
#### 功能组管理
98-
![功能组管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-permission-group.png)
97+
#### 管理员界面下的功能
98+
![管理员界面下的功能]()
9999

100-
#### 添加新功能
101-
![添加新功能](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-permission-feature.png)
100+
#### 系统用户下的功能
101+
![系统用户下的功能]()
102102

103-
#### 系统日志管理
104-
![系统日志管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-log-manger.png)
103+
#### 富文本编辑器
104+
![富文本编辑器 ]()
105105

106-
#### 管理日志的管理
107-
![工作日志的管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-log-work.png)
106+
#### 应用功能-聊天室
108107

109-
#### 管理员界面下的订单管理
110-
![管理员界面下的订单管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-orders-manger.png)
108+
![聊天室]()
111109

112-
#### 普通用户下的订单管理
113-
![普通用户下的订单管理](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/v2-orders-user.png)
110+
#### 应用功能-客服(普通用户界面 1对1)
114111

115-
#### 富文本编辑器
116-
![富文本编辑器 ](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/editor.png)
112+
![客服界面1]()
117113

118-
#### 树形组件
119-
![树形组件 ](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/tree.png)
114+
#### 应用功能-客服(客服界面 1对多)
120115

121-
#### 预览xlsx文件
122-
![预览xlsx文件 ](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/preview-xls.png)
123-
124-
#### 预览pdf文件
125-
![预览pdf文件 ](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/preview-pdf.png)
116+
![客服界面2]()
126117

127118
## 4、技术文档
128-
### [1、后端快速部署](back.md)
129-
### [2、前端快速部署](front.md)
130-
### [3、关键知识点讲述](knowledge.md)
131-
### [4、业务开发](developer.md)
119+
### [后端快速部署](back.md)
120+
### [前端快速部署](front.md)
121+
### [关键知识点讲述](knowledge.md)
122+
### [业务开发](developer.md)
123+
124+
132125

133126
## 5、 开发视频与在线辅导
134127

@@ -137,13 +130,14 @@
137130
https://v.qq.com/x/page/i3059zqgj4y.html
138131
https://v.qq.com/x/page/m3059l9bitb.html
139132
#### 目录
140-
![vue-element-admin开发管理系统](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/admin-mulu.png)
133+
![vue-element-admin开发管理系统]()
141134

142135
### 利用PHP开发微信公众号
143136
学习视频:
144137
https://url.cn/5d4wWGl?sf=uri
138+
145139
#### 目录:
146-
![微信公众号开发](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/wx-mulu.png)
140+
![微信公众号开发]()
147141

148142

149143
### 利用Laravel开发RESTful API
@@ -180,7 +174,7 @@ https://v.qq.com/x/page/t3059mfpgkg.html
180174
### 利用uni-app开发微信小程序(核心知识点)
181175

182176
#### 目录:
183-
![微信公众号开发](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/mp-mulu.png)
177+
![微信公众号开发]()
184178

185179

186180
### 在线辅导
@@ -189,27 +183,26 @@ https://v.qq.com/x/page/t3059mfpgkg.html
189183

190184
## 6、技术支持
191185
> 欢迎大家来光临我的博客,主要专注于laravel与vue.js的应用
192-
[博客](https://wmhello.github.io)
186+
[博客](https://docs.chenbont.com)
193187

194-
> 部署和使用中如果有疑问,可以到项目交流群进行讨论:106822531(QQ)或者关注公众号(computer_life)学习相关基础知识
188+
> 部署和使用中如果有疑问,可以到项目交流群进行讨论:xpyzwm(wechat)或者关注公众号(computer_life)学习相关基础知识
195189
196-
> ![QQ群二维码](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/qq_qrcode.jpg)
190+
> ![微信二维码](https://cdn.jsdelivr.net/gh/wmhello/imgs/blog/weixin1.png)
197191
198-
> ![全栈开发公众号](https://github.com/wmhello/laravel_template_with_vue/blob/master/Screenshots/gzh.jpg)
192+
> ![全栈开发公众号](https://cdn.jsdelivr.net/gh/wmhello/imgs/blog/gzh.jpg)
199193
200194

201195
## 6、打赏
202196
如果我的付出能够帮助到你,我也乐于接受你的帮助,小小的赞赏是我持续进步的动力。
203197

204-
![支付宝支付](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/pay1.jpg)
205-
![微信支付](https://github.com/wmhello/laravel_template_with_vue/raw/master/Screenshots/wx.jpg)
198+
![支付宝支付](https://cdn.jsdelivr.net/gh/wmhello/imgs/blog/pay1.jpg)
199+
200+
![微信支付](https://cdn.jsdelivr.net/gh/wmhello/imgs/blog/wx.jpg)
206201

207202
## 7、致谢
208203
站在巨人之上,我们才能走得更远。项目中使用和借鉴了以下开源框架的实现方法 一并致谢
209204
>- [laravel](https://laravel.com/)
210205
>- [后端excel插件](https://github.com/rap2hpoutre/fast-excel)
211-
>- [后端跨域](https://github.com/barryvdh/laravel-cors)
212-
>- [API接口文档](https://github.com/star7th/showdoc)
213206
>- [vue.js](https://cn.vuejs.org/index.html)
214207
>- [element ui](http://element.eleme.io/#/zh-CN)
215208
>- [vue-router](https://router.vuejs.org/)

back.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,65 @@
11
## 1、安装依赖
2-
`composer install`
2+
~~~
3+
composer install
4+
~~~
35

46
## 2、复制配置文件,进行数据库配置
5-
`cp .env.example .env`
6-
> 根据需求,配置.env文件中的DB_DATABASE、DB_USERNAME和DB_PASSWORD
7-
`php artisan key:generate`
87

8+
> 根据需求,配置.env文件中的DB_DATABASE、DB_USERNAME和DB_PASSWORD
9+
10+
~~~php
11+
cp .env.example .env
12+
php artisan key:generate
13+
~~~
914

1015
## 3、生成项目所需的数据表
16+
17+
~~~
1118
`php artisan migrate`
19+
~~~
1220

1321
## 4、使用OAuth认证,生成passport的密钥
14-
` php artisan passport:key --force`
15-
16-
php artisan passport:install --force`
22+
~~~php
23+
php artisan passport:key --force`
24+
php artisan passport:install --force`
25+
~~~
1726

1827
## 5、复制第4步生成的密钥到.env文件中,填写为PERSONAL_CLIENT_SECRET和PASSPORT_CLIENT_SECRET的参数
19-
PERSONAL_CLIENT_ID=1
2028

29+
~~~
30+
PERSONAL_CLIENT_ID=1
2131
PERSONAL_CLIENT_SECRET=
22-
2332
PASSPORT_CLIENT_ID=2
24-
2533
PASSPORT_CLIENT_SECRET=
34+
~~~
2635

2736
## 6、生成用户数据和各种结构数据
28-
`php artisan db:seed`
2937

30-
用户名和密码在database\seeds\UsersTableSeeder.php文件中明文标记
38+
> 用户名/密码: admin/123456
3139
32-
## 7、配置域名(back.test 或者其他名称)指向后端目录下的public目录(backend/public/),并在本地hosts文件中添加记录
33-
`127.0.0.1 back.test`
34-
35-
**此步骤是OAuth认证所必须,请务必设置,否则无法登录**
40+
~~~
41+
php artisan db:seed
42+
~~~
3643

44+
## 7、配置.env文件中的APP_URL为后端域名,以http或者https开头
3745
## 8、消息推送
3846

3947
需要根据要求配置laravel-echo-server,全局安装
4048

41-
`npm install -g laravel-echo-server`
49+
~~~
50+
npm install -g laravel-echo-server
51+
~~~
4252

4353
安装之后,在后端目录(backend)执行初始化
4454

45-
`laravel-echo-server init`
55+
~~~
56+
aravel-echo-server init
57+
~~~
4658

4759
相关的配置请参考相关文档,或者加我微信(xpyzwm)交流
4860

4961
配置完成之后,需要后端目录下启动laravel-echo-server 才能实现聊天、推送等功能
5062

51-
`laravel-echo-server start`
52-
53-
## 9、查看API文档地址
54-
55-
API文档使用了[showdoc](https://github.com/star7th/showdoc)
56-
如果系统部署于Windows服务器,为了保证showdoc的运行,请先检查下列条件:
57-
58-
在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持;也启用php_mbstring.dll;Linux服务器则不需要此操作。
59-
60-
61-
假设后端的域名为back.test 则文档地址为http://back.test/showdoc/web/#/1
62-
线上文档的话,可以通过进入演示系统的登录界面就可以进入
63+
~~~
64+
laravel-echo-server start
65+
~~~

front.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,17 @@
11
## 1、安装依赖
22
`npm install`
3-
3+
44
## 2、配置后端服务器
5-
文件位于frontend目录下,.env.development保存开发时的环境,.env.development保存发布后的环境
5+
前端位于element目录下,.env.development保存开发时的环境,.env.development保存发布后的环境
66

77
配置其中的VUE_APP_BASE_API地址,分别指向开发时的本地后端服务器和发布后线上后端服务器。
88

9-
10-
## 3、配置上传文件的服务器地址
11-
文件位于frontend\src\config目录下,_import_development.js保存开发时使用的各种配置,_import_production.js保存发布时使用的各种配置
12-
13-
配置其中的site地址,分别指向开发时的上传文件服务器地址和发布后的上传文件服务器地址(只需要网址)。
14-
15-
## 4、本地开发
9+
## 3、本地开发
1610
`npm run dev`
1711

1812
登录用户名和密码使用后端的用户名和密码
1913

20-
## 5、编译打包
14+
## 4、编译打包
2115
`npm run build`
2216

23-
程序打包到了frontend\dist目录
17+
程序打包到了element\dist目录

0 commit comments

Comments
 (0)