diff --git a/readme.md b/readme.md index f24b16fa8..9e4a57fc7 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,81 @@ -ThinkAdmin v6 基于 ThinkPHP 6.0 开发 ----- -目前处理开发阶段,请匆应用到线上版本项目开发!!! \ No newline at end of file +## 大道至简 · 原生框架 + +### 目前处理开发阶段,请匆应用到线上版本项目开发!!! + +ThinkAdmin v6 依赖自制组件 ThinkLibrary v6,ThinkLibrary v6 是针对 ThinkPHP 6.0 定制开发。 + +我们致力于二次开发底层框架,提供完整的组件及API,基于此框架可以快速开发应用。 + +另外项目安装及二次开发可以参考 ThinkPHP 官方文档,数据库文件摆放在项目根目录下。 + +ThinkAdmin 非常适用快速二次开发,默认集成 微信开发组件,支持微信服务号、微信支付、支付宝支付、七牛云存储、本地服务器存储等。 后台UI基于最新版本的 LayUI 及 RequireJs 加载第三方插件(建议自行了解 LayUI 及 RequireJs)。 + +#### 注意事项 +* 项目测试需要自行搭建环境导入数据库( admin_v6.sql )并修改配置( config/database.php ); +* 若操作提示“演示系统禁止操作”等字样,需要删除演示路由配置( route/admin/demo.php )或清空路由文件; +* 当前版本使用 ThinkPHP 6.0.x,对 PHP 版本标注不低于 PHP 7.1,具体请阅读 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) + +## 注解权限 + +注解权限是指通过方法注释来实现后台RBAC授权管理,用注解来管理功能节点。 + +开发人员只需要写好注释,RBAC的节点会自动生成,只需要配置角色及用户就可以使用RBAC权限。 + +* 此版本的权限使用注解实现 +* 注释必需使用标准的块注释,如下案例 +* 其中`@auth true`表示访问需要权限验证 +* 其中`@menu true`显示在菜单编辑的节点可选项 +* 其中`@menu true`需要强制登录才可访问 +```php +/** +* 操作的名称 +* @auth true # 表示需要验证权限 +* @menu true # 在菜单编辑的节点可选项 +* @login true # 需要强制登录可访问 +*/ +public function index(){ + // @todo +} +``` + +## 代码仓库 + + ThinkAdmin 为 MIT 协议开源项目,安装使用或二次开发不受约束,欢迎 fork 项目。 + + 部分代码来自互联网,若有异议可以联系作者进行删除。 + + * 在线体验地址:https://v6.thinkadmin.top (账号和密码都是 admin ) + * Gitee仓库地址:https://gitee.com/zoujingli/ThinkAdmin + * GitHub仓库地址:https://github.com/zoujingli/ThinkAdmin + + +## 框架指令 + +* 执行 `build.cmd` 可更新 `Composer` 插件,会删除并替换 `vendor` 目录 +* 执行 `php think run` 启用本地开发环境,访问 `http://127.0.0.1:8000` + +#### 1. 线上代码更新 +* 执行 `php think xadmin:install admin` 从线上服务更新 `admin` 模块的所有文件(注意文件安全) +* 执行 `php think xadmin:install static` 从线上服务更新 `plugs` 静态资料文件(注意文件安全) + +#### 2. 守护进程管理 +* 执行 `php think xtask:listen` [监听]启动任务监听主进程 +* 执行 `php think xtask:query` [监听]启动任务监听主进程 +* 执行 `php think xtask:start` [控制]查询正在运行的进程 +* 执行 `php think xtask:state` [控制]查看监听主进程状态 +* 执行 `php think xtask:stop` [控制]平滑停止所有的进程 + +## 赞助打赏 +![赞助](http://static.thinkadmin.top/pay.png) +