From b0d5dd547fd977ca3c8d82696ae4a3cc496c6aa6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=82=B9=E6=99=AF=E7=AB=8B?= Date: Sat, 18 Feb 2023 18:42:34 +0800 Subject: [PATCH] Update readme.md --- readme.md | 78 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 37 deletions(-) diff --git a/readme.md b/readme.md index a422e378e..c7f6dbdda 100644 --- a/readme.md +++ b/readme.md @@ -1,41 +1,52 @@ -大道至简 · 原生框架 ---- -> 主仓库地址：https://gitee.com/zoujingli/ThinkAdmin +## 大道至简 · 原生框架 + +[![Latest Stable Version](https://poser.pugx.org/zoujingli/thinkadmin/v/stable)](https://packagist.org/packages/zoujingli/thinkadmin) +[![Latest Unstable Version](https://poser.pugx.org/zoujingli/thinkadmin/v/unstable)](https://packagist.org/packages/zoujingli/thinkadmin) +[![Total Downloads](https://poser.pugx.org/zoujingli/thinkadmin/downloads)](https://packagist.org/packages/zoujingli/thinkadmin) +[![Monthly Downloads](https://poser.pugx.org/zoujingli/thinkadmin/d/monthly)](https://packagist.org/packages/zoujingli/thinkadmin) +[![Daily Downloads](https://poser.pugx.org/zoujingli/thinkadmin/d/daily)](https://packagist.org/packages/zoujingli/thinkadmin) +[![License](https://poser.pugx.org/zoujingli/thinkadmin/license)](https://packagist.org/packages/zoujingli/thinkadmin) ### 项目介绍 -当前`ThinkAdmin`的最新版本为[`v6.1`](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1) -，从这个版本开始正式进入插件时代，基础组件及扩展插件统一使用`Composer`管理。`ThinkAdmin`与传统`ThinkPHP` -多应用模式无差别，用户可以自行开发自己的模块，此次升级可完美兼容`ThinkAdmin v6.0`应用，原`ThinkAdmin v6.0` -只需安装`think-plugs-admin`组件即可升级到`v6.1`的插模式。 +**ThinkAdmin** 是一款遵循 **MIT** 协议开源的快速开发框架，基于最新版本 **ThinkPHP6** 的极简后台管理系统，在使用 **ThinkAdmin** 前请认真阅读[《免责声明》](https://thinkadmin.top/disclaimer)并同意该声明。 -**[查看`ThinkAdmin v6.1`详细介绍请切换至`v6.1`分支](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1)！！** +当前 **ThinkAdmin** 的最新版本为[ **v6.1** ](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1) +，从这个版本开始正式进入插件时代，基础组件及扩展插件统一使用 **Composer** 管理。**ThinkAdmin** 与传统 **ThinkPHP** +多应用模式无差别，用户可以自行开发自己的模块，此次升级可完美兼容 **ThinkAdmin v6.0** 应用，原 **ThinkAdmin v6.0** +只需安装 **ThinkPlugsAdmin** 组件即可升级到 **v6.1** 的插模式。 -非常感谢大家一直以来对`ThinkAdmin`的支持，`ThinkAdmin`从`v1`到`v6`经历了几次大的调整，但总体都是基于`ThinkPHP` -最新版本为核心在开发，以微信领域及最简后台为目标而设计。 +**[查看 ThinkAdmin v6.1 详细介绍请切换至 v6.1 分支](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1)！！** -由于现有功能并不能满足所有项目的需求，`ThinkAdmin`只做基础底层的开发，这里包括系统权限管理，系统存储配置，微信授权管理，以及常用功能集成等…… -因此`ThinkAdmin`也被大家定性为外包二开基线项目，目前已经有许多公司及个人在使用。 +**ThinkAdmin v6** 是基于 **v1**-**v5** 大版本的积累，经历了几次大的调整，结合 **ThinkPHP6** +的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及队列任务机制，另外还增加了许多友好指令！当前 **v6** +版本已经通过了数个系统实践与测试，过程中不停调整与优化，目前系统模块及微信模块已经趋于稳定，现将系统管理 **`app\admin`** +及微信管理 **`app\wechat`** 定为 **v6** 内核两大模块并以 **MIT** 协议发布，后续可能还有其他模块及相关辅助模块更新发布，敬请期待…… -ThinkAdmin v6 基于`v1-v5`版本的积累，结合`ThinkPHP 6.0` -的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及任务机制，增加了许多友好指令！`ThinkAdmin v6` -经历了数个项目实践与测试，不停调整，目前系统模块及微信模块已经趋于稳定，现将【系统管理(admin)】及【微信管理(wechat)】定为`v6` -内核两大模块并使用`MIT`协议发布，其中【微商商城(data)】仅为参考案例不做技术支持可直接删除，后续可能还有其他模块及相关辅助模块更新发布，敬请期待…… +系统核心组件 **ThinkLibrary** 封装了大量常用操作以及多应用组件，可快速开发各种应用程序，且不影响原 **ThinkPHP** +生态，大大简化编码成本；可自行选择集成 **WechatDeveloper** 组件 ( +支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付接口等 ) 及 **QRcode** +二维码生成工具等。里面还内置了ThinkPHP6多应用组件并且完美支持路由；文件存储支持本地服务器存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）等存储方式；自带异步任务处理机制，可以并列多进程执行任务，任务响应延时小于 +**0.5** 秒，兼容 **windows** 及 **linux**。 -我们致力于二次开发底层框架，提供完整的组件及`API`，基于此框架可以快速开发应用。`ThinkAdmin v6`依赖自制组件`ThinkLibrary v6` -，封装了大量常用操作，简化编码成本；默认集成`WechatDeveloper` -组件，支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付接口等。`ThinkLibrary`组件实现`ThinkPHP v6` -多应用模式及路由支持，另外还支持本地服务文件存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）。 - -另外项目安装及二次开发可以先阅读`ThinkPHP`官方文档，数据库 SQL 文件位于项目根目录下，若实在无法解决当下问题可以加入官方微信群获得帮助。 +使用 **ThinkAdmin** 需要掌握 **ThinkPHP**、**jQuery**、**LayUI**、**RequireJs** 等开发技能，后台`UI`界面基于最新版本的 +**LayUI** 前端框架以及 **RequireJs** 组件加载方式，默认加载了所有 **LayUI** +的组件，框架中可以直接使用组件（独立页面需要注册`js`加载顺序哦），使用 **RequireJs** +加载插件，互联网上资源非常多，可自行下载进行二次扩展。目前后台大部分页面为单页程序，页面加载速度非常快速，也因此后台不再支持选项卡模式。 #### 注意事项 -* 项目测试需要自行搭建环境导入数据库 SQL 文件并修改配置( config/database.php )； -* 若操作提示“演示系统禁止操作”等字样，需要删除演示路由配置( app/admin/route/demo.php )或清空路由文件； -* 当前版本使用 ThinkPHP 6.0.x，对 PHP 版本标注不低于 PHP 7.1，具体请阅读 ThinkPHP 官方文档； -* 环境需开启 PATHINFO，不再支持 ThinkPHP 的 URL 兼容模式运行（源于如何优雅地展示）； -* 项目默认不带`composer`模块`vendor`目录，下载后需要自行`composer install`安装； +* **ThinkAdmin** 是基于国内最流行的 `ThinkPHP6` 框架开发，目前对 `PHP` 版本要求不得低于 `PHP 7.2.5` + ，如果使用低版本的 `PHP` 可能会影响 `Composer` 依赖组件的安装，或将存在一定的安全隐患，具体请阅读 `ThinkPHP` 更新日志及相关文档； +* 系统的运行环境必需开启 `PATHINFO` 支持并配置对应的 `rewrite` 规则才能访问，不再支持 `ThinkPHP` 的 `URL` 兼容模式运行 ( + 源于如何优雅地展示 )，可以阅读文档部署章节； +* 代码仓库下载的文件不包含 `Composer` 组件包的 `vendor` 目录，下载后需要执行 `composer install` 或 `composer update` + 安装依赖组件，同时会触发执行数据库 `Phinx` 安装脚本； +* 为保持系统可持续在线升级功能，开发时建议不要在`app/admin`,`app/wechat`,`public/static` + 这三个目录创建或修改文件，可以自行创建其他模块再编写自己的业务代码，自定义样式及脚本可以放置在目录 `public/static/extra` + 里面。系统是基于严格类型 `PHP` 新特性开发，务必使用专业的 `IDE` ( 如：`PhpStorm`,`NetBeans`,`VsCode`,`Eclipse for PHP` + 等 ) 进行项目开发以达到更好的体验与更高的效率！ +* 若后台操作提示 “演示系统禁止操作” 等字样，需要删除演示路由的配置文件(`app/admin/route/demo.php`)； ## 技术支持 @@ -79,7 +90,7 @@ public function index(){ ## 代码仓库 -ThinkAdmin 为 MIT 协议开源项目，安装使用或二次开发不受约束，欢迎 fork 项目。 +**ThinkAdmin** 为 **MIT** 协议开源项目，安装使用或二次开发不受约束，欢迎 fork 项目。 部分代码来自互联网，若有异议可以联系作者进行删除。 @@ -95,14 +106,7 @@ ThinkAdmin 为 MIT 协议开源项目，安装使用或二次开发不受约束 * 执行 `php think xadmin:sysmenu` 重写系统菜单并生成新编号并清理已禁用的菜单 * 执行 `php think xadmin:version` 查看当前版本号，显示 `ThinkPHP` 版本及 `ThinkLibrary` 版本 -#### 1. 线上代码更新 - -* 执行 `php think xadmin:install admin` 从线上服务更新 `admin` 模块的所有文件（注意文件安全） -* 执行 `php think xadmin:install wechat` 从线上服务更新 `wechat` 模块的所有文件（注意文件安全） -* 执行 `php think xadmin:install static` 从线上服务更新 `static` 静态资料文件（注意文件安全） -* 执行 `php think xadmin:install config` 从线上服务更新 `config` 常用配置文件（注意文件安全） - -#### 2. 守护进程管理（可自建定时任务去守护监听主进程） +#### 1. 守护进程管理（可自建定时任务去守护监听主进程） * 执行 `php think xadmin:queue listen` [监听]启动异步任务监听服务 * 执行 `php think xadmin:queue start` [控制]检查创建任务监听服务（建议定时任务执行） @@ -110,7 +114,7 @@ ThinkAdmin 为 MIT 协议开源项目，安装使用或二次开发不受约束 * 执行 `php think xadmin:queue status` [控制]查看异步任务监听状态 * 执行 `php think xadmin:queue stop` [控制]平滑停止所有任务进程 -#### 3. 本地调试管理（可自建定时任务去守护监听主进程） +#### 2. 本地调试管理（可自建定时任务去守护监听主进程） * 执行 `php think xadmin:queue webstop` [调试]停止本地调试服务 * 执行 `php think xadmin:queue webstart` [调试]开启本地调试服务（建议定时任务执行）