From b6accfc111978049dff3ae94811cb5e3671fd2c5 Mon Sep 17 00:00:00 2001 From: hxuanyu <2252193204@qq.com> Date: Fri, 27 Jun 2025 16:46:13 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BC=98=E5=8C=96=20GitHub=20Pages=20=E9=83=A8?= =?UTF-8?q?=E7=BD=B2=E9=85=8D=E7=BD=AE=EF=BC=8C=E6=94=AF=E6=8C=81=20master?= =?UTF-8?q?=20=E5=88=86=E6=94=AF=EF=BC=8C=E6=9B=B4=E6=96=B0=20Node.js=20?= =?UTF-8?q?=E7=89=88=E6=9C=AC=EF=BC=8C=E8=B0=83=E6=95=B4=E6=9E=84=E5=BB=BA?= =?UTF-8?q?=E5=91=BD=E4=BB=A4=EF=BC=8C=E6=B7=BB=E5=8A=A0=E8=AF=A6=E7=BB=86?= =?UTF-8?q?=E9=83=A8=E7=BD=B2=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/deploy.yml | 9 ++- DEPLOYMENT.md | 78 +++++++++++++++++++++++++ package-lock.json | 109 +++++++++++++++++++++++++++++++++++ package.json | 3 + src/widgets/timer/Config.vue | 45 ++++++++++++--- src/widgets/timer/Widget.vue | 8 +-- vite.config.ts | 29 ++++++++-- 7 files changed, 259 insertions(+), 22 deletions(-) create mode 100644 DEPLOYMENT.md diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index c951469..4118511 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -3,7 +3,7 @@ name: Deploy to GitHub Pages on: # 当推送到main分支时触发 push: - branches: [ main ] + branches: [ main, master ] # 允许手动触发工作流 workflow_dispatch: @@ -30,14 +30,13 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v4 with: - node-version: '18' + node-version: '20' cache: 'npm' - name: Install dependencies run: npm ci - - - name: Build - run: npm run build + - name: Build for GitHub Pages + run: npm run build:github - name: Setup Pages uses: actions/configure-pages@v4 diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md new file mode 100644 index 0000000..c54e71b --- /dev/null +++ b/DEPLOYMENT.md @@ -0,0 +1,78 @@ +# 部署说明 + +本项目支持多种部署方式，每种方式都有对应的构建命令。 + +## 🚀 部署方式 + +### 1. GitHub Pages（自动部署） + +**特点**：推送代码到 `main` 或 `master` 分支后自动部署 +**URL格式**：`https://username.github.io/obs-overlay-widget/` + +**设置步骤**： +1. 推送代码到GitHub仓库 +2. 在仓库设置中启用GitHub Pages + - 进入 Settings → Pages + - Source 选择 "GitHub Actions" +3. GitHub Actions会自动构建和部署 + +### 2. 手动部署（任意服务器） + +**特点**：适用于任何Web服务器，包括Apache、Nginx、静态托管服务等 +**构建命令**： +```bash +npm run build +``` + +**部署步骤**： +1. 运行构建命令 +2. 将 `dist` 文件夹中的所有文件上传到服务器 +3. 可以部署到根目录或任何子目录 + +### 3. GitHub Pages（手动构建） + +**特点**：如果你需要手动为GitHub Pages构建 +**构建命令**： +```bash +npm run build:github +``` + +## 📝 构建命令说明 + +| 命令 | 用途 | base路径 | 适用场景 | +|------|------|----------|----------| +| `npm run dev` | 开发服务器 | `/` | 本地开发 | +| `npm run build` | 生产构建 | `./` | 手动部署到任意服务器 | +| `npm run build:github` | GitHub Pages构建 | `/obs-overlay-widget/` | 手动GitHub Pages部署 | +| `npm run preview` | 预览构建结果 | - | 本地测试构建结果 | + +## 🛠️ 技术说明 + +### Base路径配置 + +项目使用智能的base路径配置： + +- **开发模式**：使用 `/` 作为base路径 +- **生产模式**： + - 默认使用 `./`（相对路径），适用于任何部署位置 + - 如果设置了 `VITE_BASE_PATH` 环境变量，则使用指定路径 + +### 自动化部署 + +GitHub Actions工作流（`.github/workflows/deploy.yml`）会： +1. 检测代码变更 +2. 安装依赖 +3. 使用 `npm run build:github` 构建项目 +4. 自动部署到GitHub Pages + +## 🔧 自定义部署 + +如果你的仓库名不是 `obs-overlay-widget`，需要修改： + +1. **vite.config.ts** 中的仓库名 +2. **package.json** 中 `build:github` 脚本的路径 + +例如，如果仓库名是 `my-widget`： +```json +"build:github": "vue-tsc -b && cross-env VITE_BASE_PATH=/my-widget/ vite build" +``` diff --git a/package-lock.json b/package-lock.json index 1a93268..af03679 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15,8 +15,10 @@ "vue-router": "^4.5.1" }, "devDependencies": { + "@types/node": "^24.0.4", "@vitejs/plugin-vue": "^6.0.0", "@vue/tsconfig": "^0.7.0", + "cross-env": "^7.0.3", "typescript": "~5.8.3", "vite": "^7.0.0", "vue-tsc": "^2.2.10" @@ -862,6 +864,16 @@ "@types/lodash": "*" } }, + "node_modules/@types/node": { + "version": "24.0.4", + "resolved": "https://registry.npmmirror.com/@types/node/-/node-24.0.4.tgz", + "integrity": "sha512-ulyqAkrhnuNq9pB76DRBTkcS6YsmDALy6Ua63V8OhrOBgbcYt6IOdzpw5P1+dyRIyMerzLkeYWBeOXPpA9GMAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~7.8.0" + } + }, "node_modules/@types/web-bluetooth": { "version": "0.0.16", "resolved": "https://registry.npmmirror.com/@types/web-bluetooth/-/web-bluetooth-0.0.16.tgz", @@ -1193,6 +1205,40 @@ "balanced-match": "^1.0.0" } }, + "node_modules/cross-env": { + "version": "7.0.3", + "resolved": "https://registry.npmmirror.com/cross-env/-/cross-env-7.0.3.tgz", + "integrity": "sha512-+/HKd6EgcQCJGh2PSjZuUitQBQynKor4wrFbRg4DtAgS1aWO+gU52xpH7M9ScGgXSYmAVS9bIJ8EzuaGw0oNAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cross-spawn": "^7.0.1" + }, + "bin": { + "cross-env": "src/bin/cross-env.js", + "cross-env-shell": "src/bin/cross-env-shell.js" + }, + "engines": { + "node": ">=10.14", + "npm": ">=6", + "yarn": ">=1" + } + }, + "node_modules/cross-spawn": { + "version": "7.0.6", + "resolved": "https://registry.npmmirror.com/cross-spawn/-/cross-spawn-7.0.6.tgz", + "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", + "dev": true, + "license": "MIT", + "dependencies": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/csstype": { "version": "3.1.3", "resolved": "https://registry.npmmirror.com/csstype/-/csstype-3.1.3.tgz", @@ -1343,6 +1389,13 @@ "he": "bin/he" } }, + "node_modules/isexe": { + "version": "2.0.0", + "resolved": "https://registry.npmmirror.com/isexe/-/isexe-2.0.0.tgz", + "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", + "dev": true, + "license": "ISC" + }, "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmmirror.com/lodash/-/lodash-4.17.21.tgz", @@ -1435,6 +1488,16 @@ "dev": true, "license": "MIT" }, + "node_modules/path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmmirror.com/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmmirror.com/picocolors/-/picocolors-1.1.1.tgz", @@ -1522,6 +1585,29 @@ "fsevents": "~2.3.2" } }, + "node_modules/shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmmirror.com/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "shebang-regex": "^3.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmmirror.com/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, "node_modules/source-map-js": { "version": "1.2.1", "resolved": "https://registry.npmmirror.com/source-map-js/-/source-map-js-1.2.1.tgz", @@ -1562,6 +1648,13 @@ "node": ">=14.17" } }, + "node_modules/undici-types": { + "version": "7.8.0", + "resolved": "https://registry.npmmirror.com/undici-types/-/undici-types-7.8.0.tgz", + "integrity": "sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw==", + "dev": true, + "license": "MIT" + }, "node_modules/vite": { "version": "7.0.0", "resolved": "https://registry.npmmirror.com/vite/-/vite-7.0.0.tgz", @@ -1696,6 +1789,22 @@ "peerDependencies": { "typescript": ">=5.0.0" } + }, + "node_modules/which": { + "version": "2.0.2", + "resolved": "https://registry.npmmirror.com/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "license": "ISC", + "dependencies": { + "isexe": "^2.0.0" + }, + "bin": { + "node-which": "bin/node-which" + }, + "engines": { + "node": ">= 8" + } } } } diff --git a/package.json b/package.json index 22d36c8..8edbc00 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "scripts": { "dev": "vite", "build": "vue-tsc -b && vite build", + "build:github": "vue-tsc -b && cross-env VITE_BASE_PATH=/obs-overlay-widget/ vite build", "preview": "vite preview" }, "dependencies": { @@ -16,8 +17,10 @@ "vue-router": "^4.5.1" }, "devDependencies": { + "@types/node": "^24.0.4", "@vitejs/plugin-vue": "^6.0.0", "@vue/tsconfig": "^0.7.0", + "cross-env": "^7.0.3", "typescript": "~5.8.3", "vite": "^7.0.0", "vue-tsc": "^2.2.10" diff --git a/src/widgets/timer/Config.vue b/src/widgets/timer/Config.vue index bcfd7a4..c4646cd 100644 --- a/src/widgets/timer/Config.vue +++ b/src/widgets/timer/Config.vue @@ -182,7 +182,7 @@