docs: refresh project guidance and environment setup

Add env example defaults for Vite API and login settings, document
template structure and page creation flow, and align agent guidance with
current LLM development rules. Also allow committing the env example while
keeping local env files ignored.docs: refresh project guidance and environment setup

Add env example defaults for Vite API and login settings, document
template structure and page creation flow, and align agent guidance with
current LLM development rules. Also allow committing the env example while
keeping local env files ignored.
This commit is contained in:
skytek_xinliang
2026-05-05 14:29:52 +08:00
parent 23218703f9
commit 87fbc1dda8
10 changed files with 818 additions and 89 deletions
+58 -4
View File
@@ -239,10 +239,10 @@ layout 不應承擔:
- 承接畫面快取與顯示狀態
- 作為 view 與 services 之間的狀態收斂點
注意
規則
- 目前仍存`src/stores/stores/*` 的重複目錄
- 這不是分層設計的一部分,而是待整理的結構噪音
- store 檔案直接放`src/stores/*.ts`
- 不要建立 `src/stores/stores/*` 這類重複巢狀目錄
### `src/services`
@@ -272,6 +272,61 @@ layout 不應承擔:
## 目前已落地的分層模式
## Template Core 與 Demo 邊界
### Template Core
以下檔案屬於 template core,負責 app shell、layout、route、plugin、theme、HTTP 基礎設施與全域狀態:
- [main.ts](/home/carl/git/skt-vuetify-templates/src/main.ts)
- [App.vue](/home/carl/git/skt-vuetify-templates/src/App.vue)
- `src/router/index.ts`
- `src/router/guards.ts`
- `src/components/layouts/*`
- `src/views/Login.vue`
- `src/plugins/*`
- `src/styles/*`
- `src/services/client.ts`
- `src/services/interceptors.ts`
- `src/services/token.ts`
- `src/services/session.ts`
- `src/services/error.ts`
- `src/services/http-error.ts`
- `src/services/http-toast.ts`
- `src/stores/auth.ts`
- `src/stores/menu.ts`
- `src/stores/breadcrumbs.ts`
- `src/stores/favorites.ts`
- `src/stores/messages.ts`
- `src/stores/snackbar.ts`
- `src/composables/layout/*`
一般功能開發優先不要修改 template core;只有需求明確要求改變框架行為時才調整。
`src/router/routes.ts` 是新增功能 route 的正式入口,可新增 route,但不要破壞既有 layout meta、auth meta 與 catch-all route 規則。
### Demo / Example
以下檔案偏向示範資料與範例頁,可在正式專案中替換或刪除:
- `src/views/Home.vue`
- `src/components/PageIndex.vue`
- `src/views/maint/*`
- `src/components/maint/*`
- `src/composables/maint/*`
- `src/components/PageMaint.vue`
- `src/stores/students.ts`
- `src/stores/semesters.ts`
- `src/views/FncPage.vue`
- `src/views/Settings.vue`
- `src/assets/logo.png`
- `src/assets/logo.svg`
- `src/assets/robot-svgrepo-com.svg`
`maint` 是可參考的 demo feature,不是所有新專案都必須保留的核心功能。
移除 demo/example 時,要同步清理 routes、menu、language、store import、component import 與 assets。
### 模式 1`view -> page component -> page family components`
已落地頁面:
@@ -358,7 +413,6 @@ layout 不應承擔:
### 中優先度
- 清理 `src/stores/stores/*` 重複結構
- 檢查 `components/maint` 內是否仍有可再明確命名的舊名稱
-`PageMaint` 的後續演進,決定是否維持在 `components` 根目錄