快速开始

本指南将帮助你快速搭建和运行Zap Admin Vue3项目。


环境准备

确保你的开发环境满足以下要求:

  • Node.js 16.x或更高版本
  • npm 7+或yarn 1.22+
  • Git


安装

1. 克隆项目

git clone https://github.com/zapj/zap-admin-vue3.git
cd zap-admin-vue3

2. 安装依赖

# 使用npm
npm install

# 或使用yarn
yarn install

3. 启动开发服务器

# 使用npm
npm run dev

# 或使用yarn
yarn dev

启动成功后,访问 http://localhost:3000 即可看到项目运行效果。

项目配置

环境变量

项目根目录下的 .env 文件包含基本配置,你可以根据需要创建不同环境的配置文件:

  • .env - 默认配置,适用于所有环境
  • .env.development - 开发环境配置
  • .env.production - 生产环境配置
# .env 示例
VITE_APP_TITLE=Zap Admin Vue3
VITE_API_BASE_URL=/api
VITE_APP_ENV=development

API配置

src/api/config.js 文件中配置API请求相关参数:

// src/api/config.js
export default {
  baseURL: globalThis._importMeta_.env.VITE_API_BASE_URL,
  timeout: 10000,
  // 其他配置...
}

构建部署

构建生产版本

# 使用npm
npm run build

# 或使用yarn
yarn build

构建完成后,生成的静态文件将位于 dist 目录中,可以部署到任何静态文件服务器。

预览构建结果

# 使用npm
npm run preview

# 或使用yarn
yarn preview