diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..ed8952d --- /dev/null +++ b/.env.example @@ -0,0 +1,43 @@ +# ============== 环境变量模板 ============== +# 复制为 .env.development / .env.production / .env.test 后填入真实值。 +# 真实值不要 commit 到 git。 + +# 当前模式名(dev / test / prod) +VITE_MODE_NAME=development + +# 资源 CDN 前缀 +VITE_RES_URL=http://localhost:3000/ + +# 后端 API 基础地址 +# dev: http://localhost:8080/auth +# prod: https://www.violin-home.cn +VITE_APP_URL=http://localhost:8080/auth + +# 应用元信息 +VITE_APP_TITLE=violin-home +VITE_APP_ID=123456 +VITE_AGENT_ID=123456 + +# 是否启用 mock(dev 启用,prod 关闭) +VITE_LOGIN_TEST=true + +# ============== OIDC / Authentik 配置 ============== +# 三个环境的 issuer + client-id + redirect-uri 都不一样。 +# dev 与 prod 必须用 Authentik 后台两个独立的 Application, +# 因为 redirect-uri 不同(dev 走 localhost,prod 走域名)。 + +# Authentik 域名(dev / prod 共用,dev 仅用于登录页跳转) +VITE_OIDC_ISSUER=https://auth.violin-work.online + +# 客户端 ID(在 Authentik 后台创建) +# dev: violin-home-dev +# prod: violin-home +VITE_OIDC_CLIENT_ID= + +# 回调 URI(必须与 Authentik 后台配置的完全一致) +# dev: http://localhost:3000/auth/callback +# prod: https://www.violin-home.cn/auth/callback +VITE_OIDC_REDIRECT_URI= + +# 编辑器标识 +VITE_EDITOR=vscode diff --git a/.gitignore b/.gitignore index bb0506b..b18e52e 100644 --- a/.gitignore +++ b/.gitignore @@ -9,10 +9,17 @@ lerna-debug.log* node_modules dist-ssr +dist *.local +# 临时文件 +tmp/ +.opencode/ +.opencode/tmp/ + # 配置文件信息不能暴露 .env.* +!.env.example # Editor directories and files .vscode/* diff --git a/AGENT.md b/AGENT.md index fb4d8fa..3722644 100644 --- a/AGENT.md +++ b/AGENT.md @@ -1 +1,210 @@ -# AGENT.md +# AGENT.md — violin-home + +> 面向 AI agent 的工程导览:模块关系、路由约定、与后端的契约、扩展点。 +> 代码即事实,本文件是索引;如代码与本文档冲突,**以代码为准**。 + +--- + +## 项目定位 + +violin-home 是 **violin 微服务套件的统一前端门户**,部署在 `https://www.violin-home.cn/`。 + +- 认证:**Authentik OIDC**,回调路径 `/auth/callback`,前端把 code POST 到 `violin-auth` 服务换 token +- 后端:依赖 violin-auth(认证)/ violin-bookmark(书签)/ violin-calendar(日历)/ violin-onenote / violin-cloud / 等子服务 +- 域名:生产 `https://www.violin-home.cn/`;本地 dev 走 `.env.development` 的 `VITE_APP_URL` + +--- + +## 技术栈 + +| 维度 | 选型 | +|------|------| +| 框架 | Vue 3.5 + Composition API (` - - - -
- - - - -