SoybeanAdmin AntDesign 技术文档

1. 安装指南

环境准备

在开始安装前，请确保您的系统满足以下要求：

• Git: 用于版本控制和克隆项目
• NodeJS: 版本需 ≥18.12.0（推荐18.19.0或更高）
• pnpm: 版本需 ≥8.7.0（推荐8.14.0或更高）

克隆项目

您可以通过以下任一方式克隆项目仓库：

# GitHub
git clone https://github.com/soybeanjs/soybean-admin-antd.git

# Gitee
git clone https://gitee.com/honghuangdc/soybean-admin-antd.git

# Gitcode
git clone https://gitcode.com/soybeanjs/soybean-admin-antd.git

安装依赖

进入项目目录后执行：

pnpm install

注意：本项目采用pnpm monorepo管理方式，请勿使用npm或yarn安装依赖

2. 项目使用说明

启动开发服务器

pnpm dev

执行后将启动本地开发服务器，默认访问地址为http://localhost:5173

项目构建

生产环境构建命令：

pnpm build

构建完成后，静态文件将生成在dist目录中

代码同步

如需同步最新代码变更，请参考官方文档中的代码同步指南

3. 项目API使用文档

路由系统

项目采用自动化文件路由系统：

• 路由自动生成：基于文件目录结构自动生成路由配置
• 类型安全：自动生成路由类型声明
• 支持两种权限模式：
  • 前端静态路由
  • 后端动态路由

主题配置API

通过主题配置组件可动态修改：

• 主题色系
• 布局模式
• 导航栏样式
• 动画效果等

数据模拟方案

内置基于ApiFox的在线数据方案：

• 支持接口测试
• 支持请求处理
• 包含开发环境数据支持

4. 项目安装方式

开发环境安装

1. 克隆项目仓库
2. 安装依赖：pnpm i
3. 启动开发服务器：pnpm dev

生产环境部署

1. 执行构建命令：pnpm build
2. 将生成的dist目录部署至Web服务器
3. 配置Nginx/Apache等Web服务器指向该目录

移动端适配

项目已内置响应式布局，支持：

• 移动端自适应
• 触控优化
• 移动端专属组件样式

---

注意：本文档基于项目README内容编写，如需更详细的技术说明，请参考官方文档或项目Wiki。项目持续更新中，建议定期同步最新代码获取最新功能。