# ManageX 综合管理系统

**Repository Path**: hhxcaz/ManageX

## Basic Information

- **Project Name**: ManageX 综合管理系统
- **Description**: ManageX是一个基于Node.js + Koa2开发的现代化综合管理系统，提供了完整的用户认证、权限管理、设备管理、支付系统等功能模块。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-12-15
- **Last Updated**: 2025-09-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ManageX - 综合管理系统

ManageX 是一个基于 Koa2 的综合管理系统，提供用户认证、权限管理、设备管理、支付系统等功能。

## 功能特点

- 用户认证中心（统一认证）
  - 跨平台支持
  - 单点登录（SSO）
  - 用户信息管理

- 系统设置模块
  - 基于角色的权限控制（RBAC）
  - 动态路由控制
  - 系统日志管理

- 设备管理
  - ESP8266设备管理
  - 定时任务管理

- 支付系统
  - 多种支付方式支持
  - 订单管理
  - 积分系统

## 技术栈

- Node.js
- Koa2
- Sequelize
- MySQL
- JWT认证
- Winston日志

## 系统要求

- Node.js >= 14
- MySQL >= 5.7
- Redis (可选，用于会话管理)

## 安装

1. 克隆项目
```bash
git clone https://gitee.com/hhxcaz/ManageX.git
cd ManageX
```

2. 安装依赖
```bash
npm install
```

3. 配置环境变量
```bash
cp .env.example .env
# 编辑 .env 文件，填写必要的配置信息
```

4. 初始化数据库
```bash
# 确保 MySQL 服务已启动
# 系统会自动创建数据库表和初始数据
```

5. 启动服务
```bash
# 开发环境
npm run dev

# 生产环境
npm start
```

## API 文档

### 认证接口

- POST /api/v1/auth/register - 用户注册
- POST /api/v1/auth/login - 用户登录
- POST /api/v1/auth/logout - 用户登出
- GET /api/v1/auth/profile - 获取用户信息
- PUT /api/v1/auth/profile - 更新用户信息

### 权限管理接口

- POST /api/v1/permissions/roles - 创建角色
- PUT /api/v1/permissions/roles/:id - 更新角色
- DELETE /api/v1/permissions/roles/:id - 删除角色
- GET /api/v1/permissions/roles - 获取所有角色
- POST /api/v1/permissions/assign-role - 分配角色
- GET /api/v1/permissions/users/:id/permissions - 获取用户权限

### 设备管理接口

- POST /api/v1/devices - 创建设备
- PUT /api/v1/devices/:id - 更新设备
- DELETE /api/v1/devices/:id - 删除设备
- GET /api/v1/devices - 获取设备列表
- GET /api/v1/devices/:id - 获取设备详情
- PUT /api/v1/devices/:id/status - 更新设备状态
- POST /api/v1/devices/:id/schedules - 创建设备定时任务

### 支付系统接口

- POST /api/v1/orders - 创建订单
- GET /api/v1/orders - 获取订单列表
- GET /api/v1/orders/:id - 获取订单详情
- POST /api/v1/orders/:id/cancel - 取消订单
- POST /api/v1/payments - 创建支付
- PUT /api/v1/payments/:id/process - 处理支付
- POST /api/v1/payments/:id/refund - 退款

## 默认账户

系统初始化时会创建一个默认管理员账户：

- 用户名：admin
- 密码：admin123
- 邮箱：admin@example.com

首次登录后请立即修改密码。

## 开发说明

### 项目结构

```
src/
  ├── config/         # 配置文件
  ├── controllers/    # 控制器
  ├── middlewares/    # 中间件
  ├── models/         # 数据模型
  ├── routes/         # 路由
  ├── utils/          # 工具函数
  └── app.js         # 应用入口
```

### 开发规范

- 使用 ES6+ 语法
- 使用 async/await 处理异步
- 遵循 RESTful API 设计规范
- 使用统一的错误处理机制
- 保持代码注释完整

## 部署

1. 准备服务器环境
2. 配置 MySQL 数据库
3. 配置环境变量
4. 使用 PM2 或其他进程管理工具运行应用

```bash
# 使用 PM2 运行
pm2 start src/app.js --name managex
```

## 许可证

MIT License