catchAdmin/README.md

166 lines
7.1 KiB
Markdown
Raw Normal View History

2020-05-17 17:09:53 +08:00
<p align="center">
<img src="https://cdn.learnku.com/uploads/images/202005/17/18206/zSuf7Ce5kM.png!large">
</p>
2020-05-16 21:06:50 +08:00
2020-05-16 23:44:22 +08:00
<p align="center"><code>CatchAdmin</code>是一款基于<a href="http://www.thinkphp.cn/" target="_blank">thinkphp framework</a>
2021-04-27 18:33:01 +08:00
<a href="https://github.com/PanJiaChen/vue-element-admin/">element admin</a>开发而成的后台管理系统。因为 thinkphp 的简单高效,文档齐全。在看了很多 thinkphp 生态中的后台管理系统,发现没有一款合适的前后端分离系统。遂开发了 CatchAdmin。
基于新版 thinkphp6 服务者的特性,后台的每个模块都可以独立成一个服务,模块之间的功能职责更加清晰。同时后台也兼顾了后台开发前端页面,减少了前端页面代码的输出。将表格和表单都封装成了后台组件,可在后台中通过 Json 数据轻松渲染出前端页面大大提高了开发效率。CatchAdmin 同时也提供 Http 客户端Excel 的导入导出,敏感词检测,大量的内置 commands 等一系列组件工具,提高使用后台的开发体验。
2020-09-07 19:57:58 +08:00
</p>
2020-05-16 23:44:22 +08:00
<p align="center">
2021-11-30 14:37:21 +08:00
<a href="https://doc.catchadmin.com/">文档</a> |
<a href="https://vue.catchadmin.com">演示地址</a> |
<a href="https://bbs.catchadmin.com">论坛交流</a> |
2020-05-16 23:44:22 +08:00
<a href="https://gitee.com/jaguarjack/catchAdmin">项目源码</a> |
<a href="https://www.kancloud.cn/akasishikelu/thinkphp6">看云分析</a>
<a href="#extensions">扩展</a>
</p>
2020-05-16 21:06:50 +08:00
<p align="center">
2020-05-16 21:26:39 +08:00
<a href="https://gitee.com/jaguarjack/catchAdmin" target="_blank">
<img src="https://svg.hamm.cn/gitee.svg?type=star&user=jaguarjack&project=catchAdmin"/>
</a >
<a href="https://gitee.com/jaguarjack/catchAdmin" target="_blank">
<img src="https://svg.hamm.cn/gitee.svg?type=fork&user=jaguarjack&project=catchAdmin"/>
</a >
<img src="https://svg.hamm.cn/badge.svg?key=Base&value=ThinkPHP6"/>
<img src="https://svg.hamm.cn/badge.svg?key=Data&value=MySQL5.5"/>
<img src="https://svg.hamm.cn/badge.svg?key=Runtime&value=PHP7.1"/>
<img src="https://svg.hamm.cn/badge.svg?key=License&value=Apache-2.0"/>
2020-05-16 21:06:50 +08:00
</p >
2021-04-27 18:33:01 +08:00
## 后台启动流程
[![gSrLz6.png](https://z3.ax1x.com/2021/04/26/gSrLz6.png)](https://imgtu.com/i/gSrLz6)
2020-09-14 10:07:03 +08:00
## AntDV 版本
- 请使用 `v1`分支
2020-09-07 19:57:58 +08:00
## 功能
2020-09-07 20:14:03 +08:00
- [x] `用户管理` 后台用户管理
- [x] `部门管理` 配置公司的部门结构,支持树形结构
- [x] `岗位管理` 配置后台用户的职务
- [x] `菜单管理` 配置系统菜单,按钮等等
- [x] `角色管理` 配置用户担当的角色,分配权限
- [x] `数据字典` 管理后台表结构
- [x] `操作日志` 后台用户操作记录
- [x] `登录日志` 后台系统用户的登录记录
- [x] `代码生成` 生成 API 端的 CURD 操作
- [x] `敏感词` 支持敏感词配置
- [x] `附件管理` 可管理上传的文件
2020-09-17 21:22:11 +08:00
- [x] `定时任务` 可管理定时任务,而不依赖于 Crontab
2020-10-21 18:21:21 +08:00
- [x] `短信平台` 短信云管理,支持 阿里大于腾讯云UcloudSubmail
2020-09-17 21:22:11 +08:00
- [x] `云上传` 支持云上传七牛OSS腾讯
2020-09-07 20:14:03 +08:00
- [ ] `微信管理`
2020-09-07 19:57:58 +08:00
2020-01-09 22:24:06 +08:00
## 项目地址
2020-05-16 23:44:22 +08:00
- [github 地址](https://github.com/yanwenwu/catch-admin)
- [gitee 地址](https://gitee.com/jaguarjack/catchAdmin)
- [前端 Vue 项目地址](https://github.com/yanwenwu/catch-admin-vue)
2020-06-06 08:58:55 +08:00
- [文档地址](https://github.com/catch-admin/document)[个人精力实在有限,希望可以小伙伴们可以一起维护文档]
2021-09-29 12:03:43 +08:00
## 支持创作
如果项目对你有帮助,可以订阅支持我❤️。你的每一份支持是对我最大的鼓励。开源不易,感谢支持。可以通过使用 [**🎉 爱发电**](https://afdian.net/@jaguarjack)订阅支持创作。
2020-05-17 17:09:53 +08:00
## 预览
2020-09-07 19:57:58 +08:00
<table>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wucNXq.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wucm6I.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wucZpd.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wuce1A.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wucnXt.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wucKnP.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wuc3tg.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wucM0f.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wucQ78.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wuc1AS.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wuc8hQ.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wucY1s.md.png"></td>
</tr>
<tr>
<td><img src="https://s1.ax1x.com/2020/09/07/wucJpj.md.png"></td>
<td><img src="https://s1.ax1x.com/2020/09/07/wuctcn.md.png"></td>
</tr>
</table>
2020-05-17 17:09:53 +08:00
## 环境要求
2019-12-03 08:15:31 +08:00
- php7.1+ (需以下扩展)
2020-05-16 21:26:39 +08:00
- [x] mbstring
- [x] json
- [x] openssl
- [x] xml
- [x] pdo
2019-12-03 08:15:31 +08:00
- nginx
- mysql
2020-05-16 23:44:22 +08:00
### 如何安装
2020-05-17 17:09:53 +08:00
> 安装之前请确保已安装 Composer
2020-05-24 10:56:08 +08:00
#### 下载项目
- 通过 Git 下载(推荐)
2020-05-16 23:44:22 +08:00
```shell
git clone https://gitee.com/jaguarjack/catchAdmin && cd catchAdmin
curl -sS https://install.phpcomposer.com/installer | php
composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
2020-09-21 09:17:25 +08:00
composer install --ignore-platform-reqs
2020-05-24 10:56:08 +08:00
```
- composer 安装
```shell
2020-05-25 15:07:01 +08:00
composer create-project jaguarjack/catchadmin:dev-master
2020-05-16 23:44:22 +08:00
```
2020-05-24 10:56:08 +08:00
#### 安装
下载完成之后通过命令来进行安装, 一键安装 🚀
```shell
php think catch:install
```
2019-12-03 08:15:31 +08:00
2019-12-14 18:29:08 +08:00
## 体验地址
2020-01-17 17:56:54 +08:00
[体验地址](http://vue.catchadmin.com)
2020-09-21 09:17:25 +08:00
- 账号: catch@admin.com
- 密码: catchadmin
2020-01-19 15:49:19 +08:00
[catchadmin 文档地址](http://doc.catchadmin.com)
2020-02-20 15:45:29 +08:00
### 系列文章
如果是刚开始使用 thinkphp6, 以下文章可能会对你有些许帮助,文章基于 RC3 版本。整体架构是不变的。
2020-02-24 10:58:08 +08:00
- [Tp6 启动分析](https://www.kancloud.cn/akasishikelu/thinkphp6/1129385)
- [Tp6 Request 解析](https://www.kancloud.cn/akasishikelu/thinkphp6/1134496)
- [TP6 应用初始化](https://www.kancloud.cn/akasishikelu/thinkphp6/1130427)
- [Tp6 中间件分析](https://www.kancloud.cn/akasishikelu/thinkphp6/1136616)
- [Tp6 请求流程](https://www.kancloud.cn/akasishikelu/thinkphp6/1136608)
2020-02-20 15:45:29 +08:00
2021-03-28 13:00:20 +08:00
### Who used
- [uctoo 应用开发管理后台](https://gitee.com/uctoo/uctoo)
2020-02-02 18:11:27 +08:00
### Talking
2020-02-13 16:35:42 +08:00
- [论坛讨论](http://bbs.catchadmin.com)
2020-05-17 17:09:53 +08:00
- 可以提 `ISSUE`,请按照 `issue` 模板提问
2020-12-27 13:20:44 +08:00
- 加入 Q 群 `302266230` 前请先 star 项目支持一下, 备注填写用户名 + 平台。例如: JaguarJack Github
2020-02-02 18:11:27 +08:00
2020-05-16 23:44:22 +08:00
### Thanks
2021-01-24 20:27:27 +08:00
- 感谢 [JetBrains](https://www.jetbrains.com) 提供生产力巨高的 `PHPStorm``WebStorm`
2021-03-28 13:00:20 +08:00
> 排名不分先后
2020-05-16 21:26:39 +08:00
2020-05-16 23:44:22 +08:00
- [top-think/think](https://github.com/top-think/think)
2020-09-09 10:40:44 +08:00
- [element-admin](https://panjiachen.gitee.io/vue-element-admin-site/zh/)
2020-05-16 23:44:22 +08:00
- [thans/tp-jwt-auth](https://packagist.org/packages/thans/tp-jwt-auth)
- [jaguarjack/think-filesystem-cloud](https://github.com/yanwenwu/think-filesystem-cloud)
- [overtrue/wechat](https://github.com/overtrue/wechat)
- [jaguarjack/migration-generator](https://github.com/yanwenwu/migration-generator)
- [phpoffice/phpspreadsheet](https://github.com/PHPOffice/PhpSpreadsheet)