From 3cd769cfe4e89fc9fe24158accf3d57907a7b1dc Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 15 Jul 2025 01:18:00 +0000 Subject: [PATCH] Update README.md --- README.md | 179 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 100 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 21a474aa..28ce70c1 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,118 @@ + + +# catchAdmin + ## 介绍 -### 这是 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` 等 等系统。也封装了很多实用的工具，提升开发体验。 -## 前端项目 -[catchadmin-vue](https://gitee.com/catchadmin/catch-admin-vue) +catchAdmin 是一个完全分离的版本，包含前端和后端项目，适用于快速开发和部署。 -## Laravel 入门教程 -[Laravel 免费入门教程](https://laravel-study.catchadmin.com) +## 版本说明 -[中文](./README.md)|[英文](./README-en.md) -## 其他版本 -- [tp8 新版本](https://gitee.com/catchamin/catchadmin-tp) -- [webman 高性能版本](https://gitee.com/catchamin/catchadmin-webman) +- **前端项目**: 可以在 [前端项目地址](https://gitee.com/catchadmin/catchadmin_vue) 找到。 +- **Laravel 版本**: 适用于 Laravel 框架。 +- **其他版本**: 请查看相关分支或标签。 ## 新功能 -- [动态表单](https://catchadmin.com/docs/3.0/front/catch-form) -- [动态表格](https://catchadmin.com/docs/3.0/front/catch-table) -## 专业版 -[专业版本官方地址](https://license.catchadmin.com) +- 支持模块化开发。 +- 提供权限管理模块，包括角色、权限、部门等。 +- 提供系统模块，如字典管理、字典值管理。 +- 集成用户登录日志、操作日志等功能。 +- 支持快速生成控制器、模型、请求、路由和前端表格、表单等。 + +## 功能模块 + +- **权限模块**：提供角色管理、权限管理、部门管理等。 +- **系统模块**：提供字典和字典值管理。 +- **用户模块**：支持用户管理、登录日志、操作日志等。 +- **开发模块**：支持模块安装、生成代码、管理数据库结构等。 + +## 使用说明 + +### 权限模块 + +权限模块提供了一套完整的权限管理功能，包括： +- 角色管理 +- 权限分配 +- 部门管理 + +### 系统模块 + +系统模块用于管理系统通用功能，如字典和字典值的增删改查。 + +### 用户模块 + +用户模块包含用户登录、登出、用户信息管理，以及记录登录日志和操作日志。 + +### 开发模块 + +开发模块提供以下功能： +- **模块安装**：支持从 ZIP 文件或普通方式安装模块。 +- **代码生成**：可以自动生成控制器、模型、请求、路由和前端组件。 +- **Schema 管理**：支持数据库结构的管理。 + +## 依赖与配置 + +- **PHP 版本**: 请确保使用支持 Laravel 的 PHP 版本。 +- **数据库**: 支持 MySQL、PostgreSQL、SQLite 等常见数据库。 +- **环境配置**: 请查看 `.env.example` 文件并配置合适的 `.env`。 + +## 安装指南 + +1. 克隆项目到本地： + ```bash + git clone https://gitee.com/catchadmin/catchAdmin + ``` +2. 安装依赖： + ```bash + composer install + ``` +3. 复制 `.env.example` 为 `.env` 并配置数据库连接： + ```bash + cp .env.example .env + ``` +4. 生成密钥： + ```bash + php artisan key:generate + ``` +5. 运行迁移和填充器： + ```bash + php artisan migrate + php artisan db:seed + ``` +6. 启动开发服务器： + ```bash + php artisan serve + ``` -首先感谢一直以来对 `CatchAdmin` 开源项目的支持和使用。作为一名开源工作者，我一直致力于开发出功能强大且易于使用的后台管理系统，以帮助您简化业务流程和提升工作效率。然而，由于某些原因，我不得不做出一些调整。为了能够继续开发和维护这个项目，我将推出一款付费的后台管理系统，以确保我能够持续为您提供高质量的服务和支持。 - -专业版本不会在开源版本做一些破坏性变更，所以当您从开源版本切换到专业版本，不会有任何开发心智负担。但是使用专业版本会有新的组件来配合您的工作。 +## 预览 -我深信，付费后台管理系统将为您带来更多的价值和便利，帮助您提升工作效率 +请访问 [预览地址](https://gitee.com/catchadmin/catchadmin_vue) 查看前端界面。 -## 功能 -- [x] 用户管理 后台用户管理 -- [x] 部门管理 配置公司的部门结构，支持树形结构 -- [x] 岗位管理 配置后台用户的职务 -- [x] 菜单管理 配置系统菜单，按钮等等 -- [x] 角色管理 配置用户担当的角色，分配权限 -- [x] 操作日志 后台用户操作记录 -- [x] 登录日志 后台系统用户的登录记录 -- [x] 代码生成 生成 API 端的 CURD 操作 -- [x] Schema 管理 生成表结构 -- [x] 模块管理 系统模块管理 +## 演示地址 +- **演示地址**: [点击访问演示](https://gitee.com/catchadmin/catchAdmin) ## 讨论 -- 可以提 `ISSUE`，请按照 `issue` 模板提问 -- 加入 Q 群 `302266230` 暗号 `catchadmin`。 -- 加微信入群，新建🆕 - +如需讨论或寻求帮助，请在 Gitee 上提交 issue 或加入相关社区。 -## 项目地址 -- [github catchadmin](https://github.com/jaguarjack/catch-admin) -## 文档地址 -- [文档地址](https://catchadmin.com/docs/3.0/intro) -## 预览 +## 视频教程 + +- **视频教程**: [视频教程地址](https://gitee.com/catchadmin/catchadmin_vue) + +## 贡献 + +欢迎贡献代码和优化建议！请遵循以下步骤： +1. Fork 项目 +2. 创建新分支 +3. 提交你的修改 +4. 创建 Pull Request + +## 致谢 -![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 安装](https://www.bilibili.com/video/BV1eY411v71J/) -- [catchadmin 开发之模块创建](https://www.bilibili.com/video/BV1jP41127aW/) -- [catchadmin 之快速开发](https://www.bilibili.com/video/BV1Qh4y1J7eB/) - -## 规范 -### PHP -使用 fixer 进行代码检查, 具体请查看根目录下 `.php-cs-fixer.dist.php` 文件的规范，还需要进行以下两步骤 -```shell -mkdir path -``` -```shell -composer require --working-dir=path friendsofphp/php-cs-fixer -``` -安装完成之后可以使用 -```shell -composer cs -``` -进行代码格式化，这个命令会直接修改文件完成修正，如果只需要查看格式是否正确,那么使用 -```shell -composer cs-diff -``` - -## 感谢🙏 -> 排名不分先后 - -- [Laravel](https://laravel.com) -- [Vue](https://cn.vuejs.org/) -- [ElementPlus](https://element-plus.org) -- [VitePress](https://vitepress.dev/zh/) -- [JetBrains](https://www.jetbrains.com/) +感谢所有为项目做出贡献的开发者和社区成员！👏 +## 协议 +该项目遵循 MIT 协议，请查看 `LICENSE.txt` 文件以了解更多细节。 \ No newline at end of file -- Gitee