mirror of
https://gitee.com/zoujingli/ThinkAdmin.git
synced 2026-09-17 21:05:41 +08:00
docs(readme): 增加章节图标并保留目录锚点
为二级标题添加适量 emoji，改善长文档的浏览体验。 保留原有章节名称锚点，确保目录及已有章节链接继续有效，不改动正文和示例。
This commit is contained in:
Anyon
parent
88890c2155
commit
89f01d57fc
68
readme.md
68
readme.md
@ -12,7 +12,9 @@ ThinkAdmin 是一套基于 **ThinkPHP 6 / 8** 的开源后台开发框架。后
|
||||
|
||||
[官方网站与开发文档](https://thinkadmin.top) · [在线演示](https://v6.thinkadmin.top) · [版本发布](https://github.com/zoujingli/ThinkAdmin/releases) · [问题反馈](https://github.com/zoujingli/ThinkAdmin/issues)
|
||||
|
||||
## 目录
|
||||
<a id="目录"></a>
|
||||
|
||||
## 📑 目录
|
||||
|
||||
- [项目特点](#项目特点)
|
||||
- [适用场景](#适用场景)
|
||||
@ -31,7 +33,9 @@ ThinkAdmin 是一套基于 **ThinkPHP 6 / 8** 的开源后台开发框架。后
|
||||
- [支持项目](#支持项目)
|
||||
- [开源协议](#开源协议)
|
||||
|
||||
## 项目特点
|
||||
<a id="项目特点"></a>
|
||||
|
||||
## ✨ 项目特点
|
||||
|
||||
- **基础管理不用从头搭。** 用户、权限、菜单、配置、日志和文件管理都有现成页面。先把后台跑起来，就可以从自己的业务模块开始做。
|
||||
- **列表和表单，有现成的写法。** ThinkLibrary 把筛选、分页、提交、校验和状态更新做了封装。熟悉一套流程后，后续页面可以继续沿用。
|
||||
@ -39,7 +43,9 @@ ThinkAdmin 是一套基于 **ThinkPHP 6 / 8** 的开源后台开发框架。后
|
||||
- **模块怎么拆，由业务决定。** 只用于当前项目的代码，可以放在独立应用中；需要跨项目复用时，再用 Composer 管理插件的依赖和版本。
|
||||
- **能自己改，也能用于商业项目。** 项目采用 MIT 许可证，允许按许可条款修改、使用和分发。交付时保留版权与许可文本，并留意第三方组件各自的授权要求。
|
||||
|
||||
## 适用场景
|
||||
<a id="适用场景"></a>
|
||||
|
||||
## 🎯 适用场景
|
||||
|
||||
如果你正在给团队做一个内部系统，或者为客户开发一套管理后台，ThinkAdmin 可以承担其中常见的基础工作：
|
||||
|
||||
@ -52,7 +58,9 @@ ThinkAdmin 是一套基于 **ThinkPHP 6 / 8** 的开源后台开发框架。后
|
||||
|
||||
ThinkAdmin 做的是通用后台基础。客户怎么分配、订单如何流转、不同租户的数据怎样隔离，这些仍由你的业务模块来实现。
|
||||
|
||||
## 功能概览
|
||||
<a id="功能概览"></a>
|
||||
|
||||
## 🧩 功能概览
|
||||
|
||||
| 能力 | 说明 |
|
||||
| --- | --- |
|
||||
@ -115,7 +123,9 @@ ThinkAdmin 做的是通用后台基础。客户怎么分配、订单如何流转
|
||||
|
||||
做图表或内容编辑页面时，也能用到项目中的 ECharts、Vue、CKEditor 与 wangEditor 相关资源。页面文字通过语言键组织，已有语言包可以作为业务翻译的参考。
|
||||
|
||||
## 技术与组件
|
||||
<a id="技术与组件"></a>
|
||||
|
||||
## 🛠️ 技术与组件
|
||||
|
||||
找代码时，可以先按下面几部分定位。依赖声明见 [composer.json](composer.json)：
|
||||
|
||||
@ -128,7 +138,9 @@ ThinkAdmin 做的是通用后台基础。客户怎么分配、订单如何流转
|
||||
|
||||
静态资源随相关插件发布到 `public/static/`。安装时，Composer 按项目的版本约束选择依赖；实际的 PHP 与扩展要求见[环境要求](#环境要求)。
|
||||
|
||||
## 环境要求
|
||||
<a id="环境要求"></a>
|
||||
|
||||
## 📋 环境要求
|
||||
|
||||
本地体验可以先用 SQLite，不需要单独启动 MySQL；正式项目可以根据团队的数据库环境选择。无论采用哪一种方式，都要先准备 PHP、Composer 和对应扩展。
|
||||
|
||||
@ -157,7 +169,9 @@ composer --no-plugins check-platform-reqs
|
||||
|
||||
项目声明的 `PHP >=7.1` 只是最外层的依赖条件，不代表每一种依赖组合都能运行在 PHP 7.1 上。`check-platform-reqs` 会检查你实际安装的版本是否满足要求。也请确认命令行与网站使用的是同一套兼容的 PHP 环境，避免出现“命令能运行，网页却报错”的情况。
|
||||
|
||||
## 快速开始
|
||||
<a id="快速开始"></a>
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
以下安装方式二选一，建议使用不含中文和空格的项目路径。Composer 创建项目适合从发布版本开始；克隆源码适合需要查看 Git 历史、跟进 v6 分支或参与开发的情况。当前默认安装包含后台管理和微信管理模块。
|
||||
|
||||
@ -214,7 +228,9 @@ php think run --host 127.0.0.1 --port 8000
|
||||
4. **按需配置微信与任务。** 使用微信功能时，再填写自己的公众号或商户参数；需要同步或批量处理时，启动队列监听并查看任务记录。
|
||||
5. **从一个简单业务页开始。** 先完成一个列表和编辑表单，再逐步加入菜单、权限和其他业务流程。开发入口见下文[开发与扩展](#开发与扩展)。
|
||||
|
||||
## 配置与部署
|
||||
<a id="配置与部署"></a>
|
||||
|
||||
## ⚙️ 配置与部署
|
||||
|
||||
### 数据库配置
|
||||
|
||||
@ -261,7 +277,9 @@ Composer 插件可能将文件复制到 `app/`、`config/`、`public/` 等目录
|
||||
|
||||
本仓库未跟踪 `composer.lock`。业务项目应保存经过验证的依赖锁定文件与部署版本，避免不同环境重新解析出不同的依赖组合。
|
||||
|
||||
## 项目结构
|
||||
<a id="项目结构"></a>
|
||||
|
||||
## 🗂️ 项目结构
|
||||
|
||||
```text
|
||||
ThinkAdmin/
|
||||
@ -284,7 +302,9 @@ ThinkAdmin/
|
||||
|
||||
部分目录和文件由依赖安装或运行过程生成，不一定出现在初始源码中。
|
||||
|
||||
## 开发与扩展
|
||||
<a id="开发与扩展"></a>
|
||||
|
||||
## 💻 开发与扩展
|
||||
|
||||
### 后台业务开发
|
||||
|
||||
@ -355,7 +375,9 @@ npm run build
|
||||
|
||||
提交主题修改时，应同步提交相关 Less 源文件、生成的 CSS 和 source map，避免源码与页面实际使用的资源不一致。
|
||||
|
||||
## 常用命令
|
||||
<a id="常用命令"></a>
|
||||
|
||||
## ⌨️ 常用命令
|
||||
|
||||
除主题构建外，下列命令均在项目根目录执行：
|
||||
|
||||
@ -374,7 +396,9 @@ npm run build
|
||||
|
||||
后台的“系统任务管理”用于查看任务记录、执行状态和进度。`start` 只负责启动后台进程，不等同于配置了开机启动或进程崩溃后的自动恢复。
|
||||
|
||||
## 常见问题
|
||||
<a id="常见问题"></a>
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### 可以用于商业项目吗
|
||||
|
||||
@ -417,7 +441,9 @@ npm run build
|
||||
|
||||
排查错误时，可结合 `runtime/` 下的应用日志、[日志配置](config/log.php)以及 Web 服务 / PHP 错误日志；公开反馈前请移除密码、密钥、令牌及用户数据。
|
||||
|
||||
## 交流与贡献
|
||||
<a id="交流与贡献"></a>
|
||||
|
||||
## 💬 交流与贡献
|
||||
|
||||
用下来有什么问题、有哪些地方值得改，欢迎带着具体的场景来交流。修复一个问题、补充一个例子，或者把不清楚的说明改明白，都是参与项目的方式。
|
||||
|
||||
@ -427,21 +453,29 @@ npm run build
|
||||
- 提交 Pull Request 时，说明为什么改、怎样验证。不同功能尽量分开提交，前端源码与构建产物保持同步。
|
||||
- 安全问题请按[安全政策](security.md)联系维护者，不要在公开 Issue 中披露敏感信息或未修复漏洞细节。
|
||||
|
||||
## 赞助支持
|
||||
<a id="赞助支持"></a>
|
||||
|
||||
## 🤝 赞助支持
|
||||
|
||||
感谢以下支持方为 ThinkAdmin 的开发与维护提供支持：
|
||||
|
||||
- **[JetBrains](https://www.jetbrains.com/)** - 通过[开源项目支持计划](https://www.jetbrains.com/community/opensource/)，为项目活跃贡献者提供一份 [PhpStorm](https://www.jetbrains.com/phpstorm/) 使用许可，用于 ThinkAdmin 的非商业开源开发与维护。
|
||||
|
||||
## 工具推荐
|
||||
<a id="工具推荐"></a>
|
||||
|
||||
## 🧰 工具推荐
|
||||
|
||||
- **[狗狗加速](https://www.dginv.click/#/register?code=JLdSICSx)** - 网络加速服务，帮助改善 ChatGPT 等在线工具的访问体验。（邀请注册链接）
|
||||
|
||||
## 支持项目
|
||||
<a id="支持项目"></a>
|
||||
|
||||
## ⭐ 支持项目
|
||||
|
||||
如果 ThinkAdmin 帮你省下了一些开发时间，欢迎 Star、分享给同样做 PHP 开发的朋友，或者 Fork 后参与改进。开发赞助方式可以在[官方网站](https://thinkadmin.top)了解。
|
||||
|
||||
## 开源协议
|
||||
<a id="开源协议"></a>
|
||||
|
||||
## 📄 开源协议
|
||||
|
||||
本项目基于 [MIT License](license) 开源，可按许可证条款使用、修改和分发。使用或分发时应保留相应版权声明和许可文本；第三方依赖遵循各自的许可证。
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user