# SuperAdminx

**Repository Path**: petplanet/SuperAdminx

## Basic Information

- **Project Name**: SuperAdminx
- **Description**: 基于webman、react的后台框架
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.superadminx.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2025-11-06
- **Last Updated**: 2025-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 介绍
后端主要集成权限管理（可基于接口级别权限）、代码生成，后续将已经插件形式开放更多功能；前端内置多种布局，基于按钮级别的权限，扩展多种form字段及table中预览展示的多个组件

### 软件架构
后端基于[workerman](https://www.workerman.net/)的[webman](https://www.workerman.net/webman)高性能HTTP框架，常用的[ThinkORM](https://doc.thinkphp.cn/@think-orm/)、[ThinkValidate](https://doc.thinkphp.cn/v8_0/validator.html)，前端基于`react`用`js`写的，主要用到的组件库是[Ant Design](https://ant.design/index-cn)、[ProComponents](https://procomponents.ant.design/)

### 使用文档
[SuperAdminx文档](http://www.superadminx.com) [联系我们](https://www.superadminx.com/contact.html)

### 预览
[点此预览](http://www.superadminx.com/preview.html)

### 安装教程

**环境要求**
- php >= 8.1
- mysql >= 5.6
- node >= 20

**php需要的扩展**
- fileinfo
- imagemagick
- exif
- xlswriter 表格导入导出用的此扩展，如导入导出换成其它逻辑可以不用安装
- redis 非必须，如果要用消息列队或缓存用redis

**php需要解除的禁用函数**
- [点此查看webman官方说明](https://www.workerman.net/doc/webman/others/disable-function-check.html)

**开始安装**

1. 获取源码，以下3种方式任选一
``` sh
# 第一种：推荐
composer create-project superadminx/admin

# 第二种Gitee获取源码
git clone https://gitee.com/zouyi/SuperAdminx.git

# 第三种Github获取源码
git clone https://github.com/zouyi741599086/SuperAdminx.git

```

2. 如果通过**第一种方式则直接跳过**，第二、三通过git获取源码才需要进入项目根目录，安装依赖
``` sh
composer install
```

3. 数据库
- 新建数据库，编码为`utf8mb4`，导入根目录下 `superadminx.sql`，此sql是用navicat导出的
- 修改根目录下 `.env` 里面数据库配置

<br />

4. 启动项目

windows用户：双击项目根目录 `windows.bat` 或者在根目录运行 `php windows.php` 启动

linux用户：调试方式运行 `php start.php start`，守护进程方式运行 `php start.php start -d`

更多细节参考[webman官方文档](https://www.workerman.net/doc/webman/install.html)

<br />

5. 进行`根目录/public/admin_react/`，安装前端依赖
``` sh
npm install
```

6. 运行前端，即可访问`http://localhost:5200/admin/`，登录的帐号密码同 **[预览](https://www.superadminx.com/preview.html)**
``` sh
npm run dev
```