# intelliAdmin

**Repository Path**: dinguangx/intelliAdmin

## Basic Information

- **Project Name**: intelliAdmin
- **Description**: 这是一个使用 OpenSpec 驱动开发方法构建的智能后台管理系统。
项目采用前后端分离架构，后端使用Spring Boot 3 + Java 17+Shiro + mybatis plus
前端使用React + TypeScript + Ant Design
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-01-11
- **Last Updated**: 2026-01-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Intelli Admin Management System

这是一个使用 OpenSpec 驱动开发方法构建的智能后台管理系统。项目采用前后端分离架构，后端使用Spring Boot 3 + Java 17，前端使用React + TypeScript + Ant Design。

## 项目结构

```
.
├── openspec/                  # OpenSpec 规范文档
│   ├── project.md             # 项目规范和约定
│   ├── specs/                 # 功能规格文档
│   │   └── [capability]/      # 具体功能规格
│   │       ├── spec.md        # 功能规格说明
│   │       ├── plan.md        # 技术实现计划
│   │       └── tasks.md       # 任务分解
│   └── changes/               # 变更提案
│       └── [change-name]/     # 具体变更
│           ├── proposal.md    # 变更提案
│           ├── tasks.md       # 实现任务
│           └── design.md      # 设计文档
├── .specify/                  # 旧的spec-kit配置（保留向后兼容）
│   └── memory/
│       └── constitution.md    # 项目宪法文件
├── src/                       # 后端 Java 源代码
│   └── main/
│       ├── java/              # Java 源代码
│       └── resources/         # 配置文件
├── intelli-h5/                # 前端 React 源代码
│   ├── src/                   # 前端源代码
│   ├── public/                # 静态资源
│   └── package.json           # 前端依赖配置
├── sql/                       # SQL 脚本
├── 文档/                      # 项目文档
│   └── 命令/                  # 命令执行记录
├── package.json               # 项目配置和MCP服务器配置
└── pom.xml                    # Maven 构建配置
```

## OpenSpec 工作流程

本项目遵循 OpenSpec 五阶段工作流程：

1. **宪法** - 定义在 `.specify/memory/constitution.md` 文件中
2. **规格说明** - 功能规格说明在 `openspec/specs/*/spec.md` 文件中
3. **计划** - 技术计划在 `openspec/specs/*/plan.md` 文件中
4. **任务** - 任务分解在 `openspec/specs/*/tasks.md` 文件中
5. **实现** - 在源代码文件中的实际实现

## 技术栈

### 后端技术栈
- Java 17
- Spring Boot 3
- Apache Shiro (安全框架)
- MyBatis-Plus (持久层框架)
- MySQL 8 (数据库)
- Redis (缓存)
- Druid (数据库连接池)
- Lombok (减少样板代码)

### 前端技术栈
- React 18
- TypeScript
- Ant Design (UI组件库)
- Axios (HTTP客户端)
- React Router DOM (路由管理)

## 项目特性

- **规范驱动开发**：使用 OpenSpec 进行需求、设计和任务分解
- **前后端分离**：清晰的前后端职责划分
- **权限管理**：基于角色的访问控制 (RBAC)
- **审计日志**：完整记录用户操作和系统事件
- **API文档**：集成 OpenAPI/Swagger 文档
- **MCP支持**：集成 Model Context Protocol 服务

## 快速开始

### 后端启动

1. 确保已安装 Java 17 和 Maven 3.6+
2. 配置数据库连接（application.properties）
3. 运行以下命令启动后端服务：

```bash
cd /path/to/project
mvn spring-boot:run
```

后端服务将启动在 http://localhost:8080

### 前端启动

1. 确保已安装 Node.js 和 npm
2. 在 intelli-h5 目录下安装依赖：

```bash
cd intelli-h5
npm install
```

3. 启动前端开发服务器：

```bash
npm start
```

前端开发服务器将启动在 http://localhost:3000

## API 文档

项目集成了 OpenAPI 文档，启动后端服务后可通过以下地址访问：
- API 文档: http://localhost:8080/api-docs
- Swagger UI: http://localhost:8080/swagger-ui.html

## OpenSpec 集成

项目配置了 MCP (Model Context Protocol) 服务器，支持 AI 辅助开发：

```json
{
  "mcpServers": {
    "openspec": {
      "command": "npx",
      "args": ["-y", "openspec-mcp", "--with-dashboard"]
    }
  }
}
```

启动 MCP 服务器：

```bash
npx -y openspec-mcp --with-dashboard
```

MCP 仪表板将运行在 http://localhost:3000

## 开发约定

### 代码风格
- Java PO 类必须以 `PO` 结尾（例如 `AuditLogPO`）
- 包名遵循 `<module>.<function>` 格式（例如 `com.intelli.admin.common.controller`）
- 使用 camelCase 命名变量和方法
- 使用 PascalCase 命名类名和 React 组件
- 使用 UPPER_SNAKE_CASE 命名常量

### 架构模式
- 遵循分层架构：controller -> service -> domain/po -> mapper -> vo
- 使用模块前缀：`<module>.<function>`（例如 `common.controller`, `sys.service`）
- RESTful API URL 遵循 `/api/<module>/<function>/xxx` 格式

### 测试策略
- 遵循测试驱动开发（TDD）方法
- 创建带有 @SpringBootTest 注解的 BaseTest 类
- 所有测试类必须继承 BaseTest
- 新功能的代码覆盖率必须至少达到 80%