catchAdmin/README.md

76 lines
3.6 KiB
Markdown
Raw Normal View History

2023-02-16 16:02:38 +08:00
## 介绍
`CatchAdmin`是一款基于[Laravel](https://laravel.com)和[Element Plus](https://element-plus.org)二次开发而成后台管理系统。`Laravel` 社区也有许多非常优秀的后台管理系统,例如 `Nova`, 官方出品,当然是收费的,免费的有基于 `Livewire``Filament`,还有不得不说的 `Laravel Admin``CatchAdmin` 还是采用传统的前后端分离策略,`Laravel` 框架仅仅作为 `Api` 输出。将管理系统模块之间的耦合降到了最低限度。每个模块之间都有独立的控制器,路由,模型,数据表。在开发上尽可能将模块之间的影响降到最低,降低了开发上的难度。基于 `CatchAdmin `可以开发 `CMS``CRM``OA` 等 等系统。也封装了很多实用的工具,提升开发体验。
2022-12-05 23:01:12 +08:00
2023-02-16 16:02:38 +08:00
[中文](./README.md)|[英文](./README-en.md)
2022-12-05 23:01:12 +08:00
2023-02-16 16:02:38 +08:00
## 为什么是 Laravel
`V2` 版本使用`Thinkphp`,但从其社区来看,从我个人角度来看开发组的心思已经不在维护框架上,因为据观察,每一次小版本发布都会引发一些小问题,虽然不大,但给人一种不够稳定的感觉,所以思索再三,使用 `Laravel``Laravel` 社区非常繁荣,他们每周都会发布新版本,以及围绕`Laravel`构建的生态也非常完善,有 `Horizon` 队列管理工具, `Telescope` 调试工具,`Octane`(基于 `Swoole``RoadRunner` 提高性能)等等一系列的工具,而且都是免费的。
2022-12-05 23:01:12 +08:00
2023-02-16 16:02:38 +08:00
## 功能
- [x] 用户管理 后台用户管理
- [x] 部门管理 配置公司的部门结构,支持树形结构
- [x] 岗位管理 配置后台用户的职务
- [x] 菜单管理 配置系统菜单,按钮等等
- [x] 角色管理 配置用户担当的角色,分配权限
- [x] 操作日志 后台用户操作记录
- [x] 登录日志 后台系统用户的登录记录
- [x] 代码生成 生成 API 端的 CURD 操作
- [x] Schema 管理 生成表结构
- [x] 模块管理 系统模块管理
2022-12-05 23:01:12 +08:00
2023-02-16 16:02:38 +08:00
## 项目地址
- [github catchadmin](https://github.com/jaguarjack/catch-admin)
## 文档地址
- [文档地址](https://catchadmin.com/docs/3.0/intro)
## 预览
![zRrjNd.png](https://i.imgtg.com/2023/02/16/dASpg.png)
![zRsAEQ.png](https://i.imgtg.com/2023/02/16/dAsKK.png)
![zRsUv6.png](https://i.imgtg.com/2023/02/16/dA0fB.png)
![zRsV4s.png](https://i.imgtg.com/2023/02/16/dAd5s.png)
## 体验地址
[demo 地址](https://v3.catchadmin.com)
- 账户: `catch@admin.com`
- 密码: `catchadmin`
## 赞助
如果项目对你有帮助,或者在工作上帮你节省了开发时间。在力所能及的情况下,可以支持下`Catchadmin`项目, 非常感谢🙏
<img src="https://i.imgtg.com/2023/02/16/dAV0a.jpg" width = "200" alt="support"/>
2022-12-05 23:01:12 +08:00
## 规范
### PHP
使用 fixer 进行代码检查, 具体请查看根目录下 `.php-cs-fixer.dist.php` 文件的规范,还需要进行以下两步骤
```shell
2022-12-06 19:27:38 +08:00
mkdir path
2022-12-05 23:01:12 +08:00
```
```shell
composer require --working-dir=path friendsofphp/php-cs-fixer
```
安装完成之后可以使用
```shell
composer cs
```
进行代码格式化,这个命令会直接修改文件完成修正,如果只需要查看格式是否正确,那么使用
```shell
composer cs-diff
```
2023-02-16 16:02:38 +08:00
## 讨论
- [论坛讨论](https://bbs.catchadmin.com)
- 可以提 `ISSUE`,请按照 `issue` 模板提问
- 加入 Q 群 `302266230` 暗号 `catchadmin`
## 感谢🙏
> 排名不分先后
- [Laravel](https://laravel.com)
- [Vue](https://cn.vuejs.org/)
- [ElementPlus](https://element-plus.org)
- [Docusaurus](https://docusaurus.com)
- [JetBrains](https://www.jetbrains.com/)
2022-12-05 23:01:12 +08:00