Skip to content

xiaw1024/NetshManager

Repository files navigation

Netsh Manager - 可视化端口转发管理工具

一个简单、轻量的 Windows netsh 端口转发规则可视化管理工具。通过直观的图形界面,轻松添加、查看和删除端口转发规则,无需记忆和手动输入繁琐的命令行。

image


✨ 特性

  • 可视化管理: 在一个清晰的 Web 界面上查看所有端口转发规则。
  • 便捷操作: 轻松添加和删除规则,无需接触命令行。
  • 轻量高效: 基于 Vue 3 和 Tailwind CSS 构建的现代化前端界面。
  • 跨平台兼容: 后端基于 Node.js,理论上可在支持 netsh 的所有 Windows 版本上运行。
  • 免安装发布: 使用 pkg 打包为单一的 .exe 可执行文件,无需在目标机器上安装 Node.js 环境。
  • 自动化构建: 集成 GitHub Actions,实现推送标签时自动打包并创建 Release。

🛠️ 技术栈

🚀 如何使用 (最终用户)

  1. 前往本项目的 GitHub Releases 页面。
  2. 下载最新版本的 netsh-manager.exe 文件。
  3. 直接双击运行 netsh-manager.exe
  4. 程序会自动请求管理员权限(请允许),然后启动服务并打开您的默认浏览器,显示管理界面。

🧑‍💻 如何开发 (开发者)

先决条件

安装

  1. 克隆仓库:

    git clone https://github.com/xiaw1024/NetshManager.git
    cd NetshManager
  2. 安装所有工作区的依赖:

    pnpm install

开发模式

您需要同时启动前端开发服务器和后端服务。

  1. 启动后端服务:

    pnpm run server

    (注意: 在开发模式下,后端服务以普通权限运行,可能无法成功添加或删除 netsh 规则。)

  2. 启动前端开发服务器: 打开另一个终端,运行:

    pnpm run dev

    现在,您可以在浏览器中访问 Vite 提供的地址 (通常是 http://localhost:5173) 来查看和调试前端界面。

📦 构建与发布

本地构建

项目提供了两种本地构建方式:

  1. 仅构建前端:

    pnpm run build

    这会将 Vue 应用打包到 frontend/dist 目录。

  2. 打包为 .exe 可执行文件:

    pnpm run build:exe

    这个命令会首先执行前端构建,然后使用 pkg 将后端服务和前端产物一起打包成一个独立的 .exe 文件。最终的可执行文件会存放在 release/netsh-manager.exe

自动化发布 (GitHub Actions)

本项目已配置了 GitHub Actions,可通过两种方式触发,实现自动化构建和发布。

方式一:自动发布 (通过 Git 标签)

这是创建正式版本的推荐方式。

  1. 触发条件: 每当您创建一个以 v 开头的 Git 标签 (例如 v1.0.0, v1.1.0) 并将其推送到 GitHub 时,工作流会自动触发。

  2. 操作流程:

    # 1. 提交所有代码更改
    git add .
    git commit -m "feat: Prepare for release v1.0.0"
    git push origin main
    
    # 2. 创建一个新标签
    git tag v1.0.0
    
    # 3. 将标签推送到 GitHub
    git push origin v1.0.0
  3. 查看结果: 推送标签后,前往您仓库的 "Actions" 页面,可以看到工作流正在运行。成功后,一个新的、标记为 "Latest" 的正式版本将会出现在 "Releases" 页面,其中包含了打包好的 .exe 文件作为附件。

方式二:手动运行 (用于测试)

您也可以随时手动触发工作流来生成一个测试版本。

  1. 前往您仓库的 "Actions" 标签页。
  2. 在左侧边栏,点击 "Build and Release EXE" 工作流。
  3. 点击 "Run workflow" 下拉按钮。
  4. 选择您要运行的分支 (通常是 main),然后点击绿色的 "Run workflow" 按钮。
  5. 查看结果: 工作流运行结束后,会创建一个标记为 "Pre-release" 的草稿版本。您可以在 "Releases" 页面找到它并下载 .exe 文件进行测试。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors