mirror of
https://gitee.com/zoujingli/ThinkAdmin.git
synced 2025-04-06 03:58:04 +08:00
Update readme.md
This commit is contained in:
邹景立
parent
3c35aca1e4
commit
6e9e9783d3
88
readme.md
88
readme.md
@ -1,7 +1,6 @@
|
||||
## 大道至简 · 原生框架
|
||||
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
[](https://packagist.org/packages/zoujingli/thinkadmin)
|
||||
@ -11,42 +10,23 @@
|
||||
|
||||
**ThinkAdmin** 是一款遵循 **MIT** 协议开源的快速开发框架，基于最新版本 **ThinkPHP6** 的极简后台管理系统，在使用 **ThinkAdmin** 前请认真阅读[《免责声明》](https://thinkadmin.top/disclaimer)并同意该声明。
|
||||
|
||||
当前 **ThinkAdmin** 的最新版本为[ **v6.1** ](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1)
|
||||
，从这个版本开始正式进入插件时代，基础组件及扩展插件统一使用 **Composer** 管理。**ThinkAdmin** 与传统 **ThinkPHP**
|
||||
多应用模式无差别，用户可以自行开发自己的模块，此次升级可完美兼容 **ThinkAdmin v6.0** 应用，原 **ThinkAdmin v6.0**
|
||||
只需安装 **ThinkPlugsAdmin** 组件即可升级到 **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 v6.1 详细介绍请切换至 v6.1 分支](https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1)！！**
|
||||
|
||||
**ThinkAdmin v6** 是基于 **v1**-**v5** 大版本的积累，经历了几次大的调整，结合 **ThinkPHP6**
|
||||
的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及队列任务机制，另外还增加了许多友好指令！当前 **v6**
|
||||
版本已经通过了数个系统实践与测试，过程中不停调整与优化，目前系统模块及微信模块已经趋于稳定，现将系统管理 **`app\admin`**
|
||||
及微信管理 **`app\wechat`** 定为 **v6** 内核两大模块并以 **MIT** 协议发布，后续可能还有其他模块及相关辅助模块更新发布，敬请期待……
|
||||
**ThinkAdmin v6** 是基于 **v1**-**v5** 大版本的积累，经历了几次大的调整，结合 **ThinkPHP6** 的思维重新构建，减少大量原非必需的组件，自建存储层、服务层及队列任务机制，另外还增加了许多友好指令！当前 **v6** 版本已经通过了数个系统实践与测试，过程中不停调整与优化，目前系统模块及微信模块已经趋于稳定，现将系统管理 **`app\admin`** 及微信管理 **`app\wechat`** 定为 **v6** 内核两大模块并以 **MIT** 协议发布，后续可能还有其他模块及相关辅助模块更新发布，敬请期待……
|
||||
|
||||
系统核心组件 **ThinkLibrary** 封装了大量常用操作以及多应用组件，可快速开发各种应用程序，且不影响原 **ThinkPHP**
|
||||
生态，大大简化编码成本；可自行选择集成 **WechatDeveloper** 组件 (
|
||||
支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付接口等 ) 及 **QRcode**
|
||||
二维码生成工具等。里面还内置了 **ThinkPHP6** 多应用组件并且完美支持路由；文件存储支持本地服务器存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）等存储方式；自带异步任务处理机制，可以并列多进程执行任务，任务响应延时小于
|
||||
**0.5** 秒，兼容 **windows** 及 **linux**。
|
||||
系统核心组件 **ThinkLibrary** 封装了大量常用操作以及多应用组件，可快速开发各种应用程序，且不影响原 **ThinkPHP** 生态，大大简化编码成本；可自行选择集成 **WechatDeveloper** 组件 ( 支持微信公众号、微信小程序、微信企业号、微信商户支付、支付宝支付接口等 ) 及 **QRcode** 二维码生成工具等。里面还内置了 **ThinkPHP6** 多应用组件并且完美支持路由；文件存储支持本地服务器存储、七牛云对象存储（支持CDN加速）、又拍云USS存储（支持CDN加速）、阿里云OSS存储（支持CDN加速）、腾讯云COS存储（支持CDN加速）等存储方式；自带异步任务处理机制，可以并列多进程执行任务，任务响应延时小于 **0.5** 秒，兼容 **windows** 及 **linux**。
|
||||
|
||||
使用 **ThinkAdmin** 需要掌握 **ThinkPHP**、**jQuery**、**LayUI**、**RequireJs** 等开发技能，后台`UI`界面基于最新版本的
|
||||
**LayUI** 前端框架以及 **RequireJs** 组件加载方式，默认加载了所有 **LayUI**
|
||||
的组件，框架中可以直接使用组件（独立页面需要注册`js`加载顺序哦），使用 **RequireJs**
|
||||
加载插件，互联网上资源非常多，可自行下载进行二次扩展。目前后台大部分页面为单页程序，页面加载速度非常快速，也因此后台不再支持选项卡模式。
|
||||
使用 **ThinkAdmin** 需要掌握 **ThinkPHP**、**jQuery**、**LayUI**、**RequireJs** 等开发技能，后台 **UI** 界面基于最新版本的 **LayUI** 前端框架以及 **RequireJs** 组件加载方式，默认加载了所有 **LayUI** 的组件，框架中可以直接使用组件（独立页面需要注意 **js** 加载顺序哦），使用 **RequireJs** 加载插件，互联网上资源非常多，可自行下载进行二次扩展。目前后台大部分页面为单页程序，页面加载速度非常快速，也因此后台不再支持选项卡模式。
|
||||
|
||||
#### 注意事项
|
||||
|
||||
* **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`)；
|
||||
* **ThinkAdmin** 是基于国内最流行的 **ThinkPHP6** 框架开发，要求在不低于 **PHP 7.2.5** 的版本上运行，如果使用低版本的 **PHP** 可能会影响 **Composer** 依赖组件的安装，或将存在一定的安全隐患；
|
||||
* 运行环境必需开启 **PATHINFO** 并将对应的 **rewrite** 规则配置到站点才能访问，系统已不再支持 **ThinkPHP** 的 **URL** 兼容模式运行 ( 源于如何优雅地展示 )，可以阅读 **ThinkAdmin** 的文档[安装部署](https://thinkadmin.top/install)章节；
|
||||
* 代码仓库下载的文件不包含 **Composer** 组件的 **vendor** 目录，下载后需要执行 **composer install** 安装依赖组件，同时会触发执行 **php think migrate:run** 安装数据库 **Phinx** 脚本，如需切换数据库只需要先配置再执行即可完成初始化安装数据；
|
||||
* 为保持系统可持续在线升级功能，建议不要在 **app/admin**、**app/wechat** 、**public/static** 这三个目录创建或修改文件，可以自行创建其他模块再编写自己的业务代码，自定义样式及脚本可以放置在 **public/static/extra** 目录里面。
|
||||
* 系统是基于严格类型 **PHP** 新特性开发，务必使用专业的 **IDE** ( 如：**PhpStorm**、**NetBeans**、**VsCode**、**Eclipse for PHP** 等 ) 进行项目开发以达到更好的体验与更高的效率！
|
||||
|
||||
## 系统安装
|
||||
|
||||
@ -77,7 +57,7 @@ git clone https://github.com/zoujingli/ThinkAdmin
|
||||
cd ThinkAdmin
|
||||
|
||||
### 安装项目依赖组件
|
||||
composer install -o
|
||||
composer install --optimize-autoloader
|
||||
|
||||
### 数据库初始化并安装
|
||||
php think migrate:run
|
||||
@ -85,17 +65,19 @@ php think migrate:run
|
||||
|
||||
## 数据库安装
|
||||
|
||||
1. 创建空的数据库并将参数配置到 `config/database.php` 文件；
|
||||
2. 导入数据库 `SQL` 文件或执行数据库初始化操作，视版本情况操作；
|
||||
1. 创建空的数据库并将参数配置到 **config/database.php** 文件；
|
||||
2. 导入数据库 **SQL** 文件或执行数据库初始化操作，视版本情况操作；
|
||||
|
||||
* 版本是 `v6.0` 的项目需要导入项目根目录下的 `SQL01-数据表结构.sql` 和 `SQL02-数据初始化.sql` 文件；
|
||||
* 版本是 `v6.1` 的项目不需要导入数据库 `SQL` 文件，修改数据库配置后执行 `php think migrate:run` 即可；
|
||||
**温馨提示：** 当前下载的代码已经是 **v6.1** 版本！
|
||||
|
||||
* 版本是 **v6.0** 的项目需要导入项目根目录下的 `SQL01-数据表结构.sql` 和 `SQL02-数据初始化.sql` 文件；
|
||||
* 版本是 **v6.1** 的项目不需要导入数据库 `SQL` 文件，修改数据库配置后执行 `php think migrate:run` 即可；
|
||||
|
||||
## 技术支持
|
||||
|
||||
开发前请认真阅读 ThinkPHP 官方文档会对您有帮助哦！
|
||||
|
||||
本地开发请使用`php think run`运行服务，访问`http://127.0.0.1:8000`即可进入项目。
|
||||
本地开发请使用 `php think run` 运行服务，访问 `http://127.0.0.1:8000` 即可进入项目。
|
||||
|
||||
官方地址及开发指南：https://thinkadmin.top ，如果实在无法解决问题可以加入官方群免费交流。
|
||||
|
||||
@ -114,7 +96,7 @@ php think migrate:run
|
||||
开发人员只需要写好注释，RBAC 的节点会自动生成，只需要配置角色及用户就可以使用RBAC权限。
|
||||
|
||||
* 此版本的权限使用注解实现
|
||||
* 注释必须标准的块注释，如下案例
|
||||
* 注释必须是标准的块注释，案例如下展示
|
||||
* 其中`@auth true`表示访问需要权限验证
|
||||
* 其中`@menu true`菜单编辑显示可选节点
|
||||
* 其中`@login true`需要强制登录才可访问
|
||||
@ -133,13 +115,13 @@ public function index(){
|
||||
|
||||
## 代码仓库
|
||||
|
||||
主仓库放置于`Gitee`, `Github`为镜像仓库。
|
||||
主仓库放置于 **Gitee**, **Github** 为镜像仓库。
|
||||
|
||||
部分代码来自互联网，若有异议可以联系作者进行删除。
|
||||
|
||||
* 在线体验地址：https://v6.thinkadmin.top （账号和密码都是 admin ）
|
||||
* Gitee仓库地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v6.1
|
||||
* GitHub仓库地址：https://github.com/zoujingli/ThinkAdmin/tree/v6.1
|
||||
* Gitee仓库地址：https://gitee.com/zoujingli/ThinkAdmin
|
||||
* GitHub仓库地址：https://github.com/zoujingli/ThinkAdmin
|
||||
|
||||
## 框架指令
|
||||
|
||||
@ -163,6 +145,10 @@ public function index(){
|
||||
* 执行 `php think xadmin:queue webstart` [调试]开启本地调试服务（建议定时任务执行）
|
||||
* 执行 `php think xadmin:queue webstatus` [调试]查看本地调试状态
|
||||
|
||||
#### 3. 数据库打包为 Phinx 脚本（打包后的脚本需要进行修改）
|
||||
|
||||
* 执行 `php think xadmin:package` [打包]将现有数据库打包为 Phinx 脚本
|
||||
|
||||
## 问题修复
|
||||
|
||||
* 增加`CORS`跨域规则配置，配置参数置放于`config/app.php`，需要更新`ThinkLibrary`。
|
||||
@ -175,9 +161,19 @@ public function index(){
|
||||
* 增加后台主题样式配置，支持全局默认+用户个性配置，需要更新`ThinkLibrary`,`static`,`admin`组件及模块。
|
||||
* 后台行政区域数据更新，由原来的腾讯地图数据切换为百度地图最新数据，需要更新`static`，数据库版需另行更新。
|
||||
|
||||
## 项目版本
|
||||
## 版权信息
|
||||
|
||||
体验账号及密码都是 admin
|
||||
[**ThinkAdmin**](https://thinkadmin.top) 遵循 [**MIT**](license) 开源协议发布，并免费提供使用。
|
||||
|
||||
本项目包含的第三方源码和二进制文件的版权信息另行标注。
|
||||
|
||||
版权所有 Copyright © 2014-2023 by ThinkAdmin (https://thinkadmin.top) All rights reserved。
|
||||
|
||||
更多细节参阅 [`LISENSE`](license) 文件
|
||||
|
||||
## 历史版本
|
||||
|
||||
以下系统的体验账号及密码都是 admin
|
||||
|
||||
### ThinkAdmin v6 基于 ThinkPHP 6.0 开发（后台权限基于注解实现）
|
||||
|
||||
@ -214,13 +210,3 @@ public function index(){
|
||||
* 在线体验地址：https://v1.thinkadmin.top (已停用)
|
||||
* Gitee 代码地址：https://gitee.com/zoujingli/ThinkAdmin/tree/v1
|
||||
* Github 代码地址：https://github.com/zoujingli/ThinkAdmin/tree/v1
|
||||
|
||||
## 版权信息
|
||||
|
||||
[**ThinkAdmin**](https://thinkadmin.top) 遵循 [**MIT**](license) 开源协议发布，并免费提供使用。
|
||||
|
||||
本项目包含的第三方源码和二进制文件的版权信息另行标注。
|
||||
|
||||
版权所有 Copyright © 2014-2023 by ThinkAdmin (https://thinkadmin.top) All rights reserved。
|
||||
|
||||
更多细节参阅 [`LISENSE`](license) 文件
|
||||
Loading…
x
Reference in New Issue
Block a user