Skip to content
  • 推广您的产品

快速开始 ​

环境要求 ​

  • Node.js: >= 20.19.0 || >= 22.12.0 || >= 24.0.0
  • pnpm: >= 9.9.0 (推荐使用 pnpm 作为包管理器)
  • IDE: VS Code (推荐安装 Volar 插件)

安装依赖 ​

bash
# 克隆项目
git clone <repository-url>
cd zhontai-ui-admin-app

# 安装依赖
pnpm install

开发模式启动 ​

H5 模式(默认) ​

bash
# 启动 H5 开发服务器
pnpm dev

App 模式 ​

bash
# 启动 App 开发模式
pnpm dev:app

# Android App
pnpm dev:app-android

# iOS App
pnpm dev:app-ios

小程序模式 ​

bash
# 微信小程序
pnpm dev:mp-weixin

# 支付宝小程序
pnpm dev:mp-alipay

# 百度小程序
pnpm dev:mp-baidu

# 头条小程序
pnpm dev:mp-toutiao

# QQ 小程序
pnpm dev:mp-qq

# 飞书小程序
pnpm dev:mp-lark

# 快手小程序
pnpm dev:mp-kuaishou

多环境模式 ​

H5 模式支持多环境配置:

bash
# 开发环境
pnpm dev:h5:development

# 预发环境
pnpm dev:h5:staging

# 生产环境
pnpm dev:h5:production

生产构建 ​

bash
# H5 构建
pnpm build:h5

# App 构建
pnpm build:app

# 微信小程序构建
pnpm build:mp-weixin

# 其他平台构建...

API 接口代码生成 ​

本项目使用 alova 的代码生成功能,从 Swagger 文档自动生成 API 接口代码:

bash
# 生成 API 接口代码
pnpm alova-gen

生成配置位于 alova.config.ts,支持多个 Swagger 源:

  • Admin API: src/api/admin
  • Dev API: src/api/dev
  • Demo API: src/api/demo

代码规范 ​

bash
# ESLint 检查
pnpm lint

# 自动修复
pnpm lint:fix

类型检查 ​

bash
# TypeScript 类型检查
pnpm type-check

文档开发 ​

bash
# 启动文档开发服务器
pnpm docs:dev

# 构建文档
pnpm docs:build

# 预览文档
pnpm docs:preview

常见问题 ​

Node.js 版本不满足要求 ​

请升级 Node.js 到指定版本,推荐使用 nvm 或 fnm 管理 Node.js 版本。

pnpm 未安装 ​

bash
# 安装 pnpm
npm install -g pnpm

# 验证版本
pnpm -v

依赖安装失败 ​

尝试清除缓存后重新安装:

bash
# 清除缓存
pnpm store prune

# 重新安装
rm -rf node_modules pnpm-lock.yaml
pnpm install