From fd0926152572d0e6601ebc3d9028b9577a19c319 Mon Sep 17 00:00:00 2001 From: Anyon Date: Thu, 18 Jul 2019 11:24:09 +0800 Subject: [PATCH] Update README.md --- README.md | 241 +++++++++++++++++++++++------------------------------- 1 file changed, 104 insertions(+), 137 deletions(-) diff --git a/README.md b/README.md index 6e9af8303..70f282074 100644 --- a/README.md +++ b/README.md @@ -1,159 +1,126 @@ -ThinkAdmin for PHP --- -## 大道至简 · 悟在天成 - -* ThinkAdmin 是一个基于 Thinkphp 5.1.x 开发的后台管理系统，集成后台系统常用功能。 -* 项目安装及二次开发请参考 ThinkPHP 官方文档及下面的服务环境说明，数据库 sql 文件存放于项目根目录下。 ->* 注意：项目测试请另行搭建环境并创建数据库（数据库配置 config/database.php）, 切勿直接使用测试环境数据！ ->* 如果系统提示“测试系统禁止操作等字样”，可以删除项目演示路由配置（route/demo.php）或清空里面的路由记录。 ->* 当前版本使用 ThinkPHP 5.1.x 版本，对PHP版本要求不低于php5.6，具体请查阅ThinkPHP官方文档。 +[![Latest Stable Version](https://poser.pugx.org/zoujingli/thinkadmin/v/stable)](https://packagist.org/packages/zoujingli/thinkadmin) [![Total Downloads](https://poser.pugx.org/zoujingli/thinkadmin/downloads)](https://packagist.org/packages/zoujingli/thinkadmin) [![Latest Unstable Version](https://poser.pugx.org/zoujingli/thinkadmin/v/unstable)](https://packagist.org/packages/zoujingli/thinkadmin) [![License](https://poser.pugx.org/zoujingli/thinkadmin/license)](https://packagist.org/packages/zoujingli/thinkadmin) -Documentation --- -认真看看文档可能会对你的开发有所帮助哦！ +## 大道至简 · 原生框架 -文档地址：[ThinkAdmin 开发文档](https://www.kancloud.cn/zoujingli/thinkadmin/content) +ThinkAdmin V4 是一个基于 ThinkPHP 5.1 开发的后台管理系统。 +我们致力于二次开发底层框架，提供完整的组件及API，基于此框架可以快速开发应用。 -PHP开发技术交流（QQ群 513350915） +另外项目安装及二次开发可以参考 ThinkPHP 官方文档，数据库文件摆放在项目根目录下。 + +#### 注意事项 +* 项目测试需要自行搭建环境导入数据库( admin_v4.sql )并修改配置( config/database.php )； +* 若操作提示“测试系统禁止操作”等字样，需要删除演示路由配置( route/demo.php )或清空路由文件； +* 当前版本使用 ThinkPHP5.1.x，对 PHP 版本标注不低于 PHP5.6，具体请阅读 ThinkPHP 官方文档； +* 环境需开启 PATHINFO，不再支持 ThinkPHP 的 URL 兼容模式运行（源于如何优雅的展示）； + +## 技术支持 + +开发前请认真阅读 ThinkPHP 官方文档会对您有帮助哦！ + +本地开发命令`php think run`，使用`http://127.0.0.1:8000`访问项目。 + +PHP 开发技术交流（ QQ 群 513350915） [![PHP微信开发群 (SDK)](http://pub.idqqimg.com/wpa/images/group.png)](http://shang.qq.com/wpa/qunwpa?idkey=ae25cf789dafbef62e50a980ffc31242f150bc61a61164458216dd98c411832a) -Repositorie --- - ThinkAdmin 为开源项目，允许把它用于任何地方，不受任何约束，欢迎 fork 项目。 -* Gitee 托管地址：https://gitee.com/zoujingli/ThinkAdmin -* GitHub 托管地址：https://github.com/zoujingli/ThinkAdmin - -对于新版本的微信模块使用的是授权模式，需要用到 ThinkService 项目。 -* Gitee 托管地址：https://gitee.com/zoujingli/ThinkService -* GitHub 托管地址：https://github.com/zoujingli/ThinkService - -其安装与 ThinkAdmin 相似，这里就不多说了。具体可以参见微信开放平台官网 -https://open.weixin.qq.com ，ThinkService 后台具体可以配置对应参数。 - -ThinkAdmin 与 ThinkService 对接是通过 WebService 通信的，因此运行环境需要安装 Soap 模块支持。 - - -Module --- -* 简易`RBAC`权限管理（用户、权限、节点、菜单控制） -* 自建秒传文件上载组件（本地存储、七牛云存储，阿里云OSS存储） -* 基站数据服务组件（唯一随机序号、表单更新） -* `Http`服务组件（原生`CURL`封装，兼容PHP多版本） -* 微信公众号服务组件（基于[WeChatDeveloper](https://github.com/zoujingli/WeChatDeveloper)，微信网页授权获取用户信息、已关注粉丝管理、自定义菜单管理等等） -* 微信商户支付服务组件（基于[WeChatDeveloper](https://github.com/zoujingli/WeChatDeveloper)，支持JSAPI支付、扫码模式一支付、扫码模式二支付） -* 更多组件开发中... - - -Environment ---- ->1. PHP 版本不低于 PHP5.6，推荐使用 PHP7 以达到最优效果； ->2. 需开启 PATHINFO，不再支持 ThinkPHP 的 URL 兼容模式运行（源于如何优雅的展示）。 - -* Apache - -```xml - - Options +FollowSymlinks -Multiviews - RewriteEngine On - RewriteCond %{REQUEST_FILENAME} !-d - RewriteCond %{REQUEST_FILENAME} !-f - RewriteRule ^(.*)$ index.php/$1 [QSA,PT,L] - -``` - -* Nginx - -``` -server { - listen 80; - server_name wealth.demo.cuci.cc; - root /home/wwwroot/ThinkAdmin; - index index.php index.html index.htm; - - add_header X-Powered-Host $hostname; - fastcgi_hide_header X-Powered-By; - - if (!-e $request_filename) { - rewrite ^/(.+?\.php)/?(.*)$ /$1/$2 last; - rewrite ^/(.*)$ /index.php/$1 last; - } - - location ~ \.php($|/){ - fastcgi_index index.php; - fastcgi_pass 127.0.0.1:9000; - include fastcgi_params; - set $real_script_name $fastcgi_script_name; - if ($real_script_name ~ "^(.+?\.php)(/.+)$") { - set $real_script_name $1; - } - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_NAME $real_script_name; - fastcgi_param SCRIPT_FILENAME $document_root$real_script_name; - fastcgi_param PHP_VALUE open_basedir=$document_root:/tmp/:/proc/; - access_log /home/wwwlog/domain_access.log access; - error_log /home/wwwlog/domain_error.log error; - } - - location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ { - access_log off; - error_log off; - expires 30d; - } - - location ~ .*\.(js|css)?$ { - access_log off; - error_log off; - expires 12h; - } +## 权限管理 +* 此版本的权限使用注解实现管理 +* 注释必需使用标准的块注释，如下案例 +* 其中`@auth true`表示访问需要权限验证 +* 其中`@menu true`显示在菜单编辑的节点可选项 +```php +/** +* 操作的名称 +* @auth true # 表示需要验证权限 +* @menu true # 在菜单编辑的节点可选项 +*/ +public function index(){ + // @todo } ``` -Copyright --- -* ThinkAdmin 基于`MIT`协议发布，任何人可以用在任何地方，不受约束 -* ThinkAdmin 部分代码来自互联网，若有异议，可以联系作者进行删除 +## 代码仓库 + ThinkAdmin 为 MIT 协议开源项目，安装使用或二次开发不受约束，欢迎 fork 项目。 + + 部分代码来自互联网，若有异议可以联系作者进行删除。 + + * 在线体验地址：https://demo.thinkadmin.top （账号和密码都是 admin ） + * Gitee仓库地址：https://gitee.com/zoujingli/ThinkAdmin + * GitHub仓库地址：https://github.com/zoujingli/ThinkAdmin + +## 框架指令 -Sponsor --- +* 执行 `build.cmd` 可更新 `Composer` 插件，会删除并替换 `vendor` 目录 +* 执行 `php think run` 启用本地开发环境，访问 `http://127.0.0.1:8000` + +#### 1. 线上代码更新 +* 执行 `php think xsync:admin` 从线上服务更新 `admin` 模块的所有文件（注意文件安全） +* 执行 `php think xsync:wechat` 从线上服务更新 `wechat` 模块的所有文件（注意文件安全） +* 执行 `php think xsync:service` 从线上服务更新 `service` 模块的所有文件（注意文件安全） +* 执行 `php think xsync:plugs` 从线上服务更新 `plugs` 静态插件的部分文件（注意文件安全） +* 执行 `php think xsync:config` 从线上服务更新 `config` 项目配置的部分文件（注意文件安全） + +#### 2. 微信资料管理 +* 执行 `php think xfans:all` 更新已经对接的公众号全部列表 +* 执行 `php think xfans:list` 更新已经对接的公众号粉丝列表 +* 执行 `php think xfans:tags` 更新已经对接的公众号标签列表 +* 执行 `php think xfans:black` 更新已经对接的公众号黑名单列表 + +#### 3. 守护进程管理 +* 执行 `php think xtask:reset` 重启消息任务守护进程 +* 执行 `php think xtask:start` 启动消息任务守护进程 +* 执行 `php think xtask:state` 查询消息任务守护进程 +* 执行 `php think xtask:stop` 暂停消息任务守护进程 + +#### 4. 其它自定工具 +* 执行 `php think xclean:session` 清理无效的会话SESSION文件 +* 执行 `php think xclean:store` 清理无效的订单信息及定时任务 + +## 特别感谢 + +|名称|版本|描述|链接| +|---|---|---|---| +|layui|2.4.5|UI组件库|https://github.com/sentsin/layui| +|ckeditor|4.10.1|富文件编辑器|https://github.com/ckeditor/ckeditor-dev| +|pluploader|3.1.2|文件上传工具|https://www.plupload.com| +|webuploader|0.1.5|暂时不使用了|https://github.com/fex-team/webuploader| +|font-awesome|4.7.0|字体图标库|https://github.com/FortAwesome/Font-Awesome| +|ThinkPHP|5.1.37|PHP基础框架|https://github.com/top-think/framework| +|ThinkLibrary|5.1.x-dev|ThinkPHP扩展组件|https://github.com/zoujingli/ThinkLibrary| +|WeChatDeveloper|1.2.9|微信公众号组件|https://github.com/zoujingli/WeChatDeveloper| +|WeOpenDeveloper|dev-master|微信开放平台组件|https://github.com/zoujingli/WeOpenDeveloper| + +## 赞助打赏 ![赞助](http://static.thinkadmin.top/pay.png) -项目版本 --- +## 项目版本 体验账号及密码都是`admin` -* v1 基于 ThinkPHP5.0 开发 -> 在线体验地址：https://v1.thinkadmin.top +#### ThinkAdmin v1 基于 ThinkPHP 5.0 开发 +* 在线体验地址：https://v1.thinkadmin.top +* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v1 +* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v1 -> Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v1 +#### ThinkAdmin v2 基于 ThinkPHP 5.0 开发 +* 在线体验地址：https://v2.thinkadmin.top +* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v2 +* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v2 -> Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v1 +#### ThinkAdmin v3 基于 ThinkPHP 5.1 开发 +* 在线体验地址：https://v3.thinkadmin.top +* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v3 +* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v3 -* v2 基于 ThinkPHP5.0 开发 +#### ThinkAdmin v4 基于 ThinkPHP 5.1 开发 +* 在线体验地址：https://v4.thinkadmin.top +* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v4 +* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v4 -> 在线体验地址：https://v2.thinkadmin.top - -> Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v2 - -> Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v2 - -* v3 基于 ThinkPHP5.1 开发 - -> 在线体验地址：https://v3.thinkadmin.top - -> Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v3 - -> Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v3 - -* v4 基于 ThinkPHP5.1 开发 - -> 在线体验地址：https://v4.thinkadmin.top - -> Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v4 - -> Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v4 +#### ThinkAdmin v5 基于 ThinkPHP 5.1 开发（后台权限基于注解实现） +* 在线体验地址：https://v5.thinkadmin.top +* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v5 +* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v5