# aibox-admin

**Repository Path**: xpeter/aibox-admin

## Basic Information

- **Project Name**: aibox-admin
- **Description**: 基于aibox实现管理端
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 506
- **Created**: 2025-04-24
- **Last Updated**: 2025-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AIBOX 管理系统

## 项目简介

AIBOX管理系统是一个基于现代化前端技术栈构建的后台管理系统，采用 monorepo 架构设计，使用 pnpm 作为包管理工具。

## 技术栈

- 包管理：pnpm
- 构建工具：Vite
- UI框架：Ant Design
- 开发语言：TypeScript
- 代码规范：ESLint + Prettier
- 提交规范：Commitlint
- 自动部署：Turbo

## 项目架构设计

### 核心架构框架

采用"Monorepo + 微前端"架构模式：

- `apps`：应用层，包含主应用和子应用
- `packages`：公共包层，提供可复用的组件和工具
- `internal`：内部工具层，提供构建和开发支持

### 模块依赖关系图

```
aibox-admin
  │
  ├─ apps
  │   ├─ web-antd           // 主应用
  │   └─ backend-mock       // Mock服务
  │
  ├─ packages
  │   ├─ @core             // 核心功能
  │   ├─ constants         // 常量定义
  │   ├─ effects          // 副作用管理
  │   ├─ icons           // 图标资源
  │   ├─ locales        // 国际化
  │   ├─ preferences   // 用户偏好
  │   ├─ stores      // 状态管理
  │   ├─ styles     // 公共样式
  │   ├─ types     // 类型定义
  │   └─ utils    // 工具函数
  │
  └─ internal            // 内部工具
```

### 详细模块划分

#### 1. 应用层 (apps)

**核心应用**：

- `web-antd`：主应用
  - 路由管理
  - 布局管理
  - 主题配置
  - 权限控制
- `backend-mock`：Mock服务
  - 接口模拟
  - 数据生成
  - 请求拦截

#### 2. 公共包层 (packages)

采用"微内核+插件"设计模式：

**核心功能模块**：

- `@core`：核心功能
  - 状态管理
  - 路由管理
  - 权限控制
  - 主题管理
- `constants`：常量定义
  - 系统常量
  - 业务常量
  - 配置常量
- `effects`：副作用管理
  - 异步操作
  - 数据流控制
  - 状态同步
- `icons`：图标资源
  - 系统图标
  - 业务图标
  - 自定义图标
- `locales`：国际化
  - 语言包
  - 翻译工具
  - 区域设置
- `preferences`：用户偏好
  - 主题设置
  - 布局设置
  - 系统设置
- `stores`：状态管理
  - 全局状态
  - 模块状态
  - 持久化
- `styles`：公共样式
  - 主题变量
  - 通用样式
  - 动画效果
- `types`：类型定义
  - 接口定义
  - 类型声明
  - 类型工具
- `utils`：工具函数
  - 通用工具
  - 业务工具
  - 开发工具

#### 3. 内部工具层 (internal)

**核心工具**：

- 构建工具
- 开发工具
- 测试工具
- 部署工具

## 项目结构

```
├─ apps                               // 应用目录
│  ├─ web-antd                       // Web端主应用
│  └─ backend-mock                   // Mock服务
├─ packages                          // 公共包目录
│  ├─ @core                         // 核心功能模块
│  ├─ constants                     // 常量定义
│  ├─ effects                      // 副作用管理
│  ├─ icons                        // 图标资源
│  ├─ locales                      // 国际化资源
│  ├─ preferences                  // 用户偏好设置
│  ├─ stores                       // 状态管理
│  ├─ styles                       // 公共样式
│  ├─ types                        // 类型定义
│  └─ utils                        // 工具函数
├─ scripts                          // 构建脚本
└─ internal                         // 内部工具
```

## 开发指南

### 环境要求

- Node.js >= 16
- pnpm >= 8

### 安装依赖

```bash
pnpm install
```

### 开发模式

```bash
pnpm dev
```

### 构建项目

```bash
pnpm build
```

### 代码提交规范

1. 创建功能分支：`git checkout -b feature/xxx`
2. 提交代码：`git commit -m 'feat: xxx'`
3. 推送分支：`git push origin feature/xxx`
4. 创建Pull Request

## 项目特点

1. Monorepo架构，便于代码共享和版本管理
2. TypeScript支持，提供完整的类型定义
3. 模块化设计，高度可复用的组件
4. 完整的国际化支持
5. 严格的代码规范和提交规范
6. 自动化的构建和部署流程

## 注意事项

1. 遵循代码规范和提交规范
2. 保持依赖版本的一致性
3. 及时更新文档
4. 编写必要的测试用例