|
1 | | -## Introduce |
2 | | -`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. |
| 1 | +## Introduction |
| 2 | +### This is CatchAdmin V5 |
| 3 | +`CatchAdmin` is a PHP open-source backend management system built upon [Laravel 12.x](https://laravel.com) and [Element Plus](https://element-plus.org). The Laravel community has many excellent backend management systems, such as the officially produced `Nova` (which is paid), free options like `Filament` based on `Livewire`, and the notable `Laravel Admin`. CatchAdmin adopts a frontend-backend separation architecture and integrates Token authentication, permission management, dynamic routing, dynamic tables, pagination encapsulation, resource permissions, upload/download functionality, a code generator with one-click export/import, data recycle bin, and attachment management—all in a modular framework. The `Laravel` framework serves solely as an `API` output layer. It minimizes coupling between management system modules to the greatest extent possible. Each module has independent controllers, routes, models, and data tables, significantly reducing development complexity and the impact modules have on each other. Based on `CatchAdmin`, you can develop systems like `CMS`, `CRM`, `OA`, etc. It also encapsulates many practical tools to enhance the development experience. |
| 4 | + |
| 5 | +## Participating in Gitee's Annual Best WEB Project Event |
| 6 | +I am participating in Gitee's 2025 Most Popular Open-Source Software voting event. [**Come vote for me!**](https://gitee.com/activity/2025opensource?ident=IRBNBA) :joy: |
| 7 | + |
| 8 | +## Frontend Project |
| 9 | +[catchadmin-vue](https://gitee.com/catchadmin/catch-admin-vue) |
| 10 | + |
| 11 | +## Laravel Tutorials |
| 12 | +[Free Laravel Tutorials](https://laravel-study.catchadmin.com) |
3 | 13 |
|
4 | 14 | [Chinese](./README.md)|[English](./README-en.md) |
5 | 15 |
|
6 | | -## Function |
7 | | -- [x] User management Background |
8 | | -- [x] Department Management Configure the company's department structure, support tree structure |
9 | | -- [x] Position Management Configure the position of background users |
10 | | -- [x] Menu Management Configure system menus, buttons, etc. |
11 | | -- [x] Role management Configure user roles and assign permissions |
12 | | -- [x] Operation log Background user operation records |
13 | | -- [x] Login log The login record of background system users |
14 | | -- [x] Code Generation Generate CURD operations on the API side |
15 | | -- [x] Schema management Generate table structure |
16 | | -- [x] module management system |
17 | | - |
18 | | -## Project Address |
19 | | -- [github catch admin](https://github.com/jaguarjack/catch-admin) |
20 | | -- |
21 | | -## Document Address |
22 | | -- [Document Address](https://catchadmin.com/docs/3.0/intro) |
| 16 | +## Other Versions |
| 17 | +- [ThinkPHP 8 Independent Version](https://gitee.com/catchamin/catchadmin-tp) |
| 18 | +- [Webman Independent High-Performance Version](https://gitee.com/catchamin/catchadmin-webman) |
| 19 | + |
| 20 | +## New Features |
| 21 | +- [Dynamic Forms](https://doc.catchadmin.com/docs/5.0/front/catch-form) |
| 22 | +- [Dynamic Tables](https://doc.catchadmin.com/docs/5.0/front/catch-table) |
| 23 | + |
| 24 | +## Professional Edition |
| 25 | +[Professional Edition Official Website](https://license.catchadmin.com) |
| 26 | + |
| 27 | +First of all, thank you for your ongoing support and use of the `CatchAdmin` open-source project. As an open-source developer, I have always been committed to creating a powerful and easy-to-use backend management system to help you streamline business processes and improve work efficiency. However, due to certain reasons, I've had to make some adjustments. To continue developing and maintaining this project, I will be launching a paid backend management system to ensure I can continue providing you with high-quality service and support. |
| 28 | + |
| 29 | +The Professional Edition will not introduce breaking changes to the open-source version, so transitioning from the open-source to the professional version will not involve any developmental overhead. However, the Professional Edition will offer new components to enhance your workflow. |
| 30 | + |
| 31 | +I am confident that the paid backend management system will bring you more value and convenience, helping to boost your work efficiency. |
| 32 | + |
| 33 | +## Features |
| 34 | +- ☑️ **User Management**: Complete user addition, modification, deletion, and configuration. Supports different users seeing different homepages upon login. |
| 35 | +- ☑️ **Department Management**: Department organizational structure (company, department, group) presented in a tree structure. |
| 36 | +- ☑️ **Position Management**: Configure positions for users. |
| 37 | +- ☑️ **Role Management**: Tree-structured design, supports menu and button permission assignment for roles, supports data permission assignment for roles, and a robust role management system. |
| 38 | +- ☑️ **Menu Management**: Configure system menus, buttons, etc. |
| 39 | +- ☑️ **Dictionary Management**: Manage and reuse frequently used, fixed data within the system. |
| 40 | +- ☑️ **System Configuration**: Manage common system settings. |
| 41 | +- ☑️ **Operation Logs**: Query users' normal operations within the system. |
| 42 | +- ☑️ **Login Logs**: Query records of user logins to the system. |
| 43 | +- ☑️ **File Upload**: Supports `Local`, `Qiniu Cloud`, `Alibaba Cloud`, `Tencent Cloud`. |
| 44 | +- ☑️ **Attachment Management**: Manage files and images uploaded by the current system. |
| 45 | +- ☑️ **Data Table Maintenance**: Perform defragmentation and optimization on system data tables, and manage data recycling and destruction. |
| 46 | +- ☑️ **Code Generator**: Generate frontend and backend code (PHP, Vue, database migrations). Supports one-click generation into modules. |
| 47 | +- ☑️ **Supports Vue Instant Rendering**: Supports frontend Vue instant rendering without compilation. |
| 48 | +- ☑️ **Supports Plugin System**: [CatchAdmin Plugins](https://doc.catchadmin.com/docs/5.0/plugin/quickstart) are Composer packages. No need to relearn plugin development; fully integrated with the Composer ecosystem. |
| 49 | + |
| 50 | +## Discussion |
| 51 | +- You can raise an `ISSUE`. Please follow the issue template when asking questions. |
| 52 | +- Add WeChat as a friend for group entry. Note `catchadmin` when adding. |
| 53 | + |
| 54 | +<img src="wechat.png" width="200"/> |
| 55 | + |
| 56 | +## Project Links |
| 57 | +- [GitHub catchadmin](https://github.com/jaguarjack/catch-admin) |
| 58 | + |
| 59 | +## Documentation |
| 60 | +- [Documentation](https://catchadmin.com/docs/3.0/intro) |
23 | 61 |
|
24 | 62 | ## Preview |
25 | | - |
26 | | - |
27 | | - |
28 | | - |
29 | 63 |
|
30 | | -## Demo Address |
31 | | -[demo address](https://v3.catchadmin.com) |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +## Demo |
| 70 | +[Demo Link](https://pro.catchadmin.com) |
32 | 71 | - Account: `catch@admin.com` |
33 | 72 | - Password: `catchadmin` |
34 | 73 |
|
35 | | -## Sponsorship |
36 | | -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 🙏 |
37 | | -<img src="https://i.imgtg.com/2023/02/16/dAV0a.jpg" width = "200" alt="support"/> |
| 74 | +## Video Tutorials (😂 Remember to like, share, and subscribe!) |
| 75 | +- [CatchAdmin Installation](https://www.bilibili.com/video/BV1eY411v71J/) |
| 76 | +- [CatchAdmin Development: Module Creation](https://www.bilibili.com/video/BV1jP41127aW/) |
| 77 | +- [CatchAdmin: Rapid Development](https://www.bilibili.com/video/BV1Qh4y1J7eB/) |
38 | 78 |
|
39 | | -## Specification |
40 | | -###PHP |
41 | | -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 |
42 | | -```shell |
43 | | -mkdir path |
44 | | -``` |
45 | | -```shell |
46 | | -composer require --working-dir=path friendsofphp/php-cs-fixer |
47 | | -``` |
48 | | -After the installation is complete, you can use |
| 79 | +## Standards |
| 80 | +### PHP |
| 81 | +Uses Laravel Pint for code formatting. |
49 | 82 | ```shell |
50 | | -composer cs |
| 83 | +composer format |
51 | 84 | ``` |
52 | | -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 |
| 85 | +Uses PHPStan for static analysis. |
53 | 86 | ```shell |
54 | | -composer cs-diff |
| 87 | +composer analyse |
55 | 88 | ``` |
56 | 89 |
|
57 | | -## Thanks 🙏 |
58 | | -> Ranked in no particular order |
| 90 | +## Acknowledgements 🙏 |
| 91 | +> Listed in no particular order. |
59 | 92 |
|
60 | 93 | - [Laravel](https://laravel.com) |
61 | 94 | - [Vue](https://cn.vuejs.org/) |
62 | 95 | - [ElementPlus](https://element-plus.org) |
63 | | -- [Docusaurus](https://docusaurus.com) |
| 96 | +- [VitePress](https://vitepress.dev/zh/) |
64 | 97 | - [JetBrains](https://www.jetbrains.com/) |
0 commit comments