linx6g/skt-vuetify-templates
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: document env files and configure proxy target

Browse Source 
Add VITE_PROXY_TARGET to the example environment file and use it in
the Vite dev proxy configuration with a localhost fallback. Expand the
LLM development guide with env file loading order, version-control
rules, and variable descriptions. Also clean up ignored local tool
paths in .gitignore and remove duplicated README env examples.chore: document env files and configure proxy target

Add VITE_PROXY_TARGET to the example environment file and use it in
the Vite dev proxy configuration with a localhost fallback. Expand the
LLM development guide with env file loading order, version-control
rules, and variable descriptions. Also clean up ignored local tool
paths in .gitignore and remove duplicated README env examples.
This commit is contained in:
skytek_xinliang
2026-05-20 09:50:35 +08:00
parent e90d412956
commit 4d66718b05
6 changed files with 48 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/llm-development-guide.md
+37
View File
@@ -64,6 +64,43 @@
- 錯誤頁：讀 `src/views/GUIDE.md`（ErrorShell 模式）與 `src/router/GUIDE.md`（錯誤頁路由慣例）。
- 語系文案：讀 `src/language/GUIDE.md`。
## 環境變數（.env 檔案）
Vite 會依 mode 自動載入對應層級的 `.env` 檔案，優先順序由高到低：
```
.env.[mode].local ← 本機覆蓋，不提交（最高優先）
.env.[mode] ← mode 專用
.env.local ← 本機覆蓋，不提交
.env ← 所有 mode 通用
```
專案實際使用與版本控制規則：
| 檔案 | 用途 | Git |
|------|------|-----|
| `.env.example` | 範本檔，列出所有可用變數與說明 | 提交 |
| `.env` | 所有 Vite 指令皆載入（serve / build） | 忽略 |
| `.env.development` | `vite serve`（mode=development）載入 | 忽略 |
| `.env.development.local` | 本機開發機密值（帳號密碼等） | 忽略 |
| `.env.production` | `vite build`（mode=production）載入 | 忽略 |
**新增環境變數時應遵守的順序：**
1. 在 `.env` 或 `.env.development` 中新增變數並給定預設值
2. 在 `.env.example` 中加入該變數的說明與格式，供其他開發者參考
3. 若變數包含機密資訊（帳號、密碼、token），僅放在 `.env.development.local`，不要寫入 `.env.example` 的預設值
**現有變數說明：**
| 變數 | 適用檔案 | 說明 |
|------|----------|------|
| `VITE_PROXY_TARGET` | `.env`, `.env.development`, `.env.development.local` | dev server proxy 目標後端 URL |
| `VITE_API_BASE_URL` | `.env`, `.env.development`, `.env.production` | API 請求 base URL，dev 用相對路徑走 proxy，prod 用完整 URL |
| `VITE_SKIP_LOGIN` | `.env.development` | 登入示範開關，`true` 時略過登入流程 |
| `VITE_DEV_DEFAULT_USER_ID` | `.env.development.local` | 本機開發示範帳號 |
| `VITE_DEV_DEFAULT_PASSWORD` | `.env.development.local` | 本機開發示範密碼 |
## 修改前檢查
- 是否碰到 template core。