LogoPAX ADMIN PRO

环境变量

.env                # 在所有的环境中被载入
.env.[mode]         # 只在指定的模式中被载入

.env 中主要存放一些公共配置,这些配置一般来说开发、测试、生产等环境是相同的,如:

# 项目名称(展示用)
VITE_APP_TITLE=PAX ADMIN PRO
# 项目版本
VITE_APP_VERSION=1.0.0
# 项目二级目录
VITE_APP_BASE=/nebula-wcs
# Client Id
VITE_CLIENT_ID=nebula-wcs2

.env.[mode] 中存放一些指定环境特有的配置,如:

# 后端API地址
VITE_API_URL=https://nebula-sit.klond.com.cn/nebula-wcs/
# 授权中心
VITE_AUTH_CENTER=https://nebula-sit.klond.com.cn
# 用户中心
VITE_USER_CENTER=https://nebula-sit.klond.com.cn/admin
# 登录重定向地址
VITE_REDIRECT_URI=http://192.168.10.68:3000/nebula-wcs

在项目运行或构建之前,需要先执行 node scripts/generate-config.mjs 脚本以生成所需的配置文件。该脚本负责生成配置文件 public/config.js,供后续的开发服务器启动或构建流程使用。

"scripts": {
    "dev": "NODE_ENV=development node scripts/generate-config.mjs && vite",
    "build": "NODE_ENV=production node scripts/generate-config.mjs && vite build",
    ...
}

使用场景

开发环境

在本地启动开发服务器前,需确保配置文件已生成:

npm run dev

此命令会自动调用 node scripts/generate-config.mjs 生成配置文件 public/config.js,然后启动 Vite 开发服务器。

生产环境构建

在打包部署前,需生成对应配置文件:

npm run build

该命令会先调用 node scripts/generate-config.mjs 生成配置文件 public/config.js,随后执行 Vite 构建流程, Vite 在构建时会将 public 目录中的静态文件拷贝到 dist 目录中,并最终调用 scripts/release.mjs 完成构建任务。


手动执行脚本

你也可以手动运行以下命令来单独生成配置文件:

npm install node scripts/generate-config.mjs

这适用于调试或检查配置生成逻辑的情况。


如何在开发中运用

在需要使用配置的地方,直接引入 @/config 即可:

<script lang="ts" setup>
import config from '@/config'

console.log(config.title)

</script>

注意事项

  1. 依赖管理:请确保项目依赖已正确安装(dotenv)。
npm install dotenv --save
  1. Node.js 版本:建议使用 Node.js v16 或更高版本以支持 .mjs 模块格式。
  2. 配置文件输出路径:具体输出路径和文件名由 generate-config.mjs 内容决定,请参考脚本内部实现。

参考内容


✅ 好处

特性是否支持
运行时可修改配置✅ 是
可用 .env 管理✅ 是
支持 CI/CD 注入✅ 是
不需每次手动改 config.js✅ 是

On this page