HqHelper 托管指南与准则

托管指南

HqHelper 的本体只是一个用 vite 与 vue 构建的前端项目，可以被部署在任意服务器上。

基础构建方法

安装 git, nodejs 与 npm 等必要依赖之后即可拉取项目代码并构建，例如：

git pull https://github.com/InfSein/hqhelper-dawntrail.git
cd hqhelper-dawntrail
npm i
npm run build

之后就能在拉取位置的 ./hqhelper-dawntrail/dist 目录下看到构建好的前端文件。

自动构建方法

HqHelper 会周期性地更新，因此托管服务器需要考虑自动拉取新代码并构建的方法。

Github Webhook

如果您愿意遵循我们的托管准则，请 新建一个空白Issue ，在描述中表示您希望托管 HqHelper 的意向，我们会在审查后将您指定的 API 入口加入到项目的 Webhooks 中。

定时任务

您也可以尝试周期性地拉取项目更新，例如：

• 每隔一段时间运行 git 的拉取指令，并进行构建
• 每隔一段时间就向 https://infsein.github.io/hqhelper-dawntrail/version.json 发起请求，得到最新版本的版本号信息

托管准则

我们目前的 开源准则 并未作出实际限制，您在您自己的服务器上部署 HqHelper 也并不需要经过我们的批准。不过，如果您希望您的托管服务器被我们正式地使用，并推荐给其他使用官方版 HqHelper 的用户，则须遵循以下准则：

• 需要为 HqHelper 的主页提供一个尽可能简短的公开域名 (例如备用站I的 hqhelper.nbb.fan)
• 不可私自更改 HqHelper 的代码，包括但不限于 添加广告 和 要求注册/关注公众号方可使用 等