update readme

2023-02-16 16:02:38 +08:00 · 2023-02-16 16:02:38 +08:00 · 2f154c50bf
commit 2f154c50bf
parent 2f70efa65e
2 changed files with 115 additions and 11 deletions
--- a/README-en.md
+++ b/README-en.md
@ -0,0 +1,64 @@
+## Introduce
+`CatchAdmin` is a background management system based on secondary development of [Laravel](https://laravel.com) and [Element Plus](https://element-plus.org). The `Laravel` community also has many excellent background management systems, such as `Nova`, an official product, which is of course charged, and `Filament` based on `Livewire` is free, and `Laravel Admin` has to be said. `CatchAdmin` still adopts the traditional front-end and back-end separation strategy, and the `Laravel` framework is only exported as `Api`. Coupling between management system modules is minimized. Each module has independent controllers, routes, models, and data tables. In terms of development, the influence between modules is minimized as much as possible, which reduces the difficulty of development. Based on `CatchAdmin`, systems such as `CMS`, `CRM`, `OA`, etc. can be developed. It also encapsulates many practical tools to enhance the development experience.
+
+[Chinese](./README.md)|[English](./README-en.md)
+
+## Function
+- [x] User management Background
+- [x] Department Management Configure the company's department structure, support tree structure
+- [x] Position Management Configure the position of background users
+- [x] Menu Management Configure system menus, buttons, etc.
+- [x] Role management Configure user roles and assign permissions
+- [x] Operation log Background user operation records
+- [x] Login log The login record of background system users
+- [x] Code Generation Generate CURD operations on the API side
+- [x] Schema management Generate table structure
+- [x] module management system
+
+## Project Address
+- [github catch admin](https://github.com/jaguarjack/catch-admin)
+- 
+## Document Address
+- [Document Address](https://catchadmin.com/docs/3.0/intro)
+
+## Preview
+![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 Address
+[demo address](https://v3.catchadmin.com)
+- Account: `catch@admin.com`
+- Password: `catchadmin`
+
+## Sponsorship
+If the project helps you, or saves you development time at work. If you can, you can support the `Catchadmin` project, thank you very much 🙏
+<img src="https://i.imgtg.com/2023/02/16/dAV0a.jpg" width = "200" alt="support"/>
+
+## Specification
+###PHP
+Use fixer for code checking, please refer to the specifications of the `.php-cs-fixer.dist.php` file in the root directory for details, and the following two steps are required
+```shell
+mkdir path
+```
+```shell
+composer require --working-dir=path friendsofphp/php-cs-fixer
+```
+After the installation is complete, you can use
+```shell
+composer cs
+```
+Format the code, this command will directly modify the file to complete the correction, if you only need to check whether the format is correct, then use
+```shell
+composer cs-diff
+```
+
+## Thanks 🙏
+> Ranked in no particular order
+
+- [Laravel](https://laravel.com)
+- [Vue](https://cn.vuejs.org/)
+- [ElementPlus](https://element-plus.org)
+- [Docusaurus](https://docusaurus.com)
+- [JetBrains](https://www.jetbrains.com/)
--- a/README.md
+++ b/README.md
@ -1,18 +1,44 @@
-## About CatchAdmin
+## 介绍
+`CatchAdmin`是一款基于[Laravel](https://laravel.com)和[Element Plus](https://element-plus.org)二次开发而成后台管理系统。`Laravel` 社区也有许多非常优秀的后台管理系统，例如 `Nova`, 官方出品，当然是收费的，免费的有基于 `Livewire` 的 `Filament`，还有不得不说的 `Laravel Admin`。`CatchAdmin` 还是采用传统的前后端分离策略，`Laravel` 框架仅仅作为 `Api` 输出。将管理系统模块之间的耦合降到了最低限度。每个模块之间都有独立的控制器，路由，模型，数据表。在开发上尽可能将模块之间的影响降到最低，降低了开发上的难度。基于 `CatchAdmin `可以开发 `CMS`，`CRM`，`OA` 等 等系统。也封装了很多实用的工具，提升开发体验。

+[中文](./README.md)|[英文](./README-en.md)

-## 安装
-```shell
-yarn install
+## 为什么是 Laravel
+`V2` 版本使用`Thinkphp`，但从其社区来看，从我个人角度来看开发组的心思已经不在维护框架上，因为据观察，每一次小版本发布都会引发一些小问题，虽然不大，但给人一种不够稳定的感觉，所以思索再三，使用 `Laravel`。`Laravel` 社区非常繁荣，他们每周都会发布新版本，以及围绕`Laravel`构建的生态也非常完善，有 `Horizon` 队列管理工具, `Telescope` 调试工具，`Octane`（基于 `Swoole` 和 `RoadRunner` 提高性能）等等一系列的工具，而且都是免费的。

-yarn dev
-```
+## 功能
+- [x] 用户管理 后台用户管理
+- [x] 部门管理 配置公司的部门结构，支持树形结构
+- [x] 岗位管理 配置后台用户的职务
+- [x] 菜单管理 配置系统菜单，按钮等等
+- [x] 角色管理 配置用户担当的角色，分配权限
+- [x] 操作日志 后台用户操作记录
+- [x] 登录日志 后台系统用户的登录记录
+- [x] 代码生成 生成 API 端的 CURD 操作
+- [x] Schema 管理 生成表结构 
+- [x] 模块管理 系统模块管理

-```
-composer install
+## 项目地址
+- [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"/>

-php artisan serve
-```
 ## 规范
 ### PHP
 使用 fixer 进行代码检查, 具体请查看根目录下 `.php-cs-fixer.dist.php` 文件的规范，还需要进行以下两步骤
@ -30,6 +56,20 @@ composer cs
 ```shell
 composer cs-diff
 ```
-会列出不符合的代码格式
+
+## 讨论
+- [论坛讨论](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/)