# FastAdmin

**Repository Path**: darrenliu/fastadmin

## Basic Information

- **Project Name**: FastAdmin
- **Description**: FastAdmin 后台框架开源且可以免费商用，一键生成 CRUD，
FastAdmin 是一款基于 ThinkPHP 和 Bootstrap 的极速后台开发框架，基于Auth验证的权限管理系统，一键生成 CRUD，自动生成控制器、模型、视图、JS、语言包、菜单、回收站等。（Fast Admin 极速 后台 框架）
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: 1.x-dev
- **Homepage**: https://www.fastadmin.net/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2397
- **Created**: 2025-11-15
- **Last Updated**: 2025-11-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FastAdmin

FastAdmin是一款基于ThinkPHP+Bootstrap的极速后台开发框架。

## 项目概览

- **运行环境**：PHP ≥ 7.4、MySQL、Composer、Node.js（可选用于前端资源构建）。
- **核心入口**：
  - `public/index.php`：Web 入口（前台 + 后台共用）。
  - `think`：CLI 工具，执行 `php think` 相关命令。
- **主要服务端模块**：
  - `application/admin`：后台管理端（RBAC、插件管理、可视化 CRUD）。
  - `application/index`：前台站点示例。
  - `application/api`：REST API（Token、短信/邮件验证码、用户接口）。
  - `application/common`：跨模块的基类、行为、中间件、模型与工具库。
- **可插拔扩展**：`addons/` 目录包含多种示例/生产插件，通过命令行或后台 UI 安装。

## 目录结构速览

| 目录/文件 | 说明 |
| --- | --- |
| `application/admin/controller` | 后台控制器（Auth、Dashboard、User、插件、示例等）。 |
| `application/admin/view` | 与控制器同名的后台视图（基于 Bootstrap + AdminLTE）。 |
| `application/admin/command` | CLI 脚本：一键 CRUD、菜单生成、插件打包、静态资源压缩等。 |
| `application/api/controller` | API 端点（登录、注册、验证码、Demo）。 |
| `application/common/library` | 认证、上传、短信、邮件、Token 等通用服务。 |
| `application/common/model` | 通用模型（用户、附件、配置、版本信息等）。 |
| `application/index` | 前台展示控制器与视图，演示会员中心流程。 |
| `application/extra/*.php` | 站点、上传、队列、插件等额外配置。 |
| `addons/` | 插件示例（命令行、日志、数据库备份等）。 |
| `extend/fast/*.php` | 自定义辅助类（树结构、表单、加解密、随机数、版本比较等）。 |
| `public/` | Web 可访问目录（路由适配、静态资源、模板指引）。 |
| `Gruntfile.js / package.json` | 前端构建脚本，压缩打包 JS/CSS 与版本化配置。 |

## 模块与业务逻辑

- **权限体系**：`application/admin/library/Auth.php` + `admin/model` 下的 `Admin`、`AuthGroup`、`AuthRule` 等表模型，配合中间件实现多角色、多级授权。
- **插件机制**：`application/admin/controller/Addon.php` 与 `addons/*` 目录配合；CLI `php think addon:*` 负责安装/卸载/打包。
- **脚手架**：`application/admin/command/Crud.php` 读取数据库结构与模版 `stubs/`，可一键生成控制器、模型、视图、JS、语言包、菜单。
- **API 安全**：`application/api/controller` 与 `application/common/library/Token.php` 提供 Token 发放、刷新、校验；`library/Sms.php`、`Ems.php` 集成第三方渠道。
- **上传与存储**：`application/common/library/Upload.php` 支持本地与云端（七牛/OSS/腾讯云）策略；`public/uploads` 为默认落地目录。
- **任务与队列**：`application/extra/queue.php` 配置、`topthink/think-queue` 驱动；可使用 `php think queue:listen` 处理异步任务。

## 本地开发步骤

1. **安装依赖**

   ```bash
   cd fastadmin
   composer install
   npm install           # 如需构建前端资源
   ```
2. **初始化配置**
   - 复制 `application/database.php`、`application/extra/*.php` 根据环境修改。
   - 导入 `application/admin/command/Install/fastadmin.sql` 或使用 ThinkPHP 安装向导。
3. **启动服务**
   - 内置服务器：`php think run -H 0.0.0.0 -p 8000`
   - Nginx/Apache：指向 `public/` 目录，配合自带 `nginx.htaccess` / `router.php`。
4. **构建资源（可选）**

   ```bash
   npm run dev    # 开发模式
   npm run build  # 生产打包（调用 Grunt/RequireJS 压缩流程）
   ```

## 常用 CLI 命令

- `php think addon:list|install|uninstall`：插件管理。
- `php think crud --table=xxx`：根据数据表生成 CRUD 模块。
- `php think menu --controller=xxx`：生成菜单及权限规则。
- `php think queue:listen`：启动队列 Worker。
- `php think api:build`：导出 API 文档（结合模板）。

## 调试 & 测试建议

- 开启 `application/config.php` 中的 `app_debug` 以查看详细报错。
- `application/common/behavior/Common.php` 中定义了全局行为，可在此插入日志以跟踪请求链。
- 使用 Postman/Apifox 对 `application/api` 接口做 Token 鉴权测试，确保 `Token.php`、`User.php` 逻辑可用。
- 针对插件开发，优先在 `addons/example` 模块调试，确认 `info.ini`、`config.php`、`install.sql` 三件套完整。


## 主要特性

* 基于`Auth`验证的权限管理系统
    * 支持无限级父子级权限继承，父级的管理员可任意增删改子级管理员及权限设置
    * 支持单管理员多角色
    * 支持管理子级数据或个人数据
* 强大的一键生成功能
    * 一键生成CRUD,包括控制器、模型、视图、JS、语言包、菜单、回收站等
    * 一键压缩打包JS和CSS文件，一键CDN静态资源部署
    * 一键生成控制器菜单和规则
    * 一键生成API接口文档
* 完善的前端功能组件开发
    * 基于`AdminLTE`二次开发
    * 基于`Bootstrap`开发，自适应手机、平板、PC
    * 基于`RequireJS`进行JS模块管理，按需加载
    * 基于`Less`进行样式开发
* 强大的插件扩展功能，在线安装卸载升级插件
* 通用的会员模块和API模块
* 共用同一账号体系的Web端会员中心权限验证和API接口会员权限验证
* 二级域名部署支持，同时域名支持绑定到应用插件
* 多语言支持，服务端及客户端支持
* 支持大文件分片上传、剪切板粘贴上传、拖拽上传，进度条显示，图片上传前压缩
* 支持表格固定列、固定表头、跨页选择、Excel导出、模板渲染等功能
* 强大的第三方应用模块支持([CMS](https://www.fastadmin.net/store/cms.html)、[CRM](https://www.fastadmin.net/store/facrm.html)、[企业网站管理系统](https://www.fastadmin.net/store/ldcms.html)、[知识库文档系统](https://www.fastadmin.net/store/knowbase.html)、[在线投票系统](https://www.fastadmin.net/store/vote.html)、[B2C商城](https://www.fastadmin.net/store/shopro.html)、[B2B2C商城](https://www.fastadmin.net/store/wanlshop.html))
* 整合第三方短信接口(阿里云、腾讯云短信)
* 无缝整合第三方云存储(七牛云、阿里云OSS、腾讯云存储、又拍云)功能，支持云储存分片上传
* 第三方富文本编辑器支持(Summernote、百度编辑器)
* 第三方登录(QQ、微信、微博)整合
* 第三方支付(微信、支付宝)无缝整合，微信支持PC端扫码支付
* 丰富的插件应用市场

## 安装使用

https://doc.fastadmin.net

## 在线演示

https://demo.fastadmin.net

用户名：admin

密　码：123456

提　示：演示站数据无法进行修改，请下载源码安装体验全部功能

## 界面截图
![控制台](https://images.gitee.com/uploads/images/2020/0929/202947_8db2d281_10933.gif "控制台")

## 问题反馈

在使用中有任何问题，请使用以下联系方式联系我们

问答社区: https://ask.fastadmin.net

Github: https://github.com/fastadminnet/fastadmin

Gitee: https://gitee.com/fastadminnet/fastadmin

## 特别鸣谢

感谢以下的项目,排名不分先后

ThinkPHP：http://www.thinkphp.cn

AdminLTE：https://adminlte.io

Bootstrap：http://getbootstrap.com

jQuery：http://jquery.com

Bootstrap-table：https://github.com/wenzhixin/bootstrap-table

Nice-validator: https://validator.niceue.com

SelectPage: https://github.com/TerryZ/SelectPage

Layer: https://layuion.com/layer/

DropzoneJS: https://www.dropzonejs.com


## 版权信息

FastAdmin遵循Apache2开源协议发布，并提供免费使用。

本项目包含的第三方源码和二进制文件之版权信息另行标注。

版权所有Copyright © 2017-2024 by FastAdmin (https://www.fastadmin.net)

All rights reserved。