79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
# 环境变量配置
|
||
|
||
## 配置说明
|
||
|
||
项目支持通过环境变量配置，支持不同环境的部署需求。参考 `goalfymax-front` 项目的环境变量配置方式。
|
||
|
||
## 环境变量文件
|
||
|
||
### 开发环境
|
||
创建 `.env.development` 文件：
|
||
```bash
|
||
VITE_API_BASE_URL=http://localhost:8084
|
||
VITE_APP_TITLE=GoalfyMax Admin
|
||
VITE_APP_VERSION=1.0.0
|
||
VITE_ENABLE_DEVTOOLS=true
|
||
VITE_USE_MOCK=false
|
||
```
|
||
|
||
### 生产环境
|
||
创建 `.env.production` 文件：
|
||
```bash
|
||
VITE_API_BASE_URL=https://your-production-api.com
|
||
VITE_APP_TITLE=GoalfyMax Admin
|
||
VITE_APP_VERSION=1.0.0
|
||
VITE_ENABLE_DEVTOOLS=false
|
||
VITE_USE_MOCK=false
|
||
```
|
||
|
||
### 测试环境
|
||
创建 `.env.test` 文件：
|
||
```bash
|
||
VITE_API_BASE_URL=https://your-test-api.com
|
||
VITE_APP_TITLE=GoalfyMax Admin
|
||
VITE_APP_VERSION=1.0.0
|
||
VITE_ENABLE_DEVTOOLS=true
|
||
VITE_USE_MOCK=false
|
||
```
|
||
|
||
## 使用方法
|
||
|
||
### 1. 复制环境变量模板
|
||
```bash
|
||
cp env.example .env.development
|
||
```
|
||
|
||
### 2. 修改配置
|
||
编辑对应的环境变量文件，设置正确的配置值。
|
||
|
||
### 3. 启动项目
|
||
```bash
|
||
# 开发环境
|
||
npm run dev
|
||
|
||
# 生产环境构建
|
||
npm run build
|
||
```
|
||
|
||
## 环境变量说明
|
||
|
||
| 变量名 | 说明 | 默认值 |
|
||
|--------|------|--------|
|
||
| `VITE_API_BASE_URL` | API 基础地址 | `http://localhost:8084` |
|
||
| `VITE_APP_TITLE` | 应用标题 | `GoalfyMax Admin` |
|
||
| `VITE_APP_VERSION` | 应用版本 | `1.0.0` |
|
||
| `VITE_ENABLE_DEVTOOLS` | 启用开发工具 | `true` |
|
||
| `VITE_USE_MOCK` | 使用 Mock 数据 | `false` |
|
||
|
||
## 代理配置
|
||
|
||
开发环境下，Vite 会自动代理 `/api` 请求到 `VITE_API_BASE_URL`，无需在代码中硬编码 API 地址。
|
||
|
||
## 注意事项
|
||
|
||
1. 环境变量文件需要以 `.env` 开头
|
||
2. 变量名必须以 `VITE_` 开头才能在客户端代码中使用
|
||
3. 生产环境构建时，环境变量会被编译到代码中
|
||
4. 敏感信息不要放在环境变量中，应该通过后端配置
|
||
5. 开发环境使用代理，生产环境直接使用环境变量中的 API 地址
|