开发

开发指南

开发环境使用 Git、Yarn 和 Node.js 18，版本见 web/.nvmrc。切换分支时，请核对对应的 .nvmrc 和 web/package.json。建议了解 Vue.js、MQTT 和 TypeScript 等相关知识。

如需贡献代码，请先 Fork 仓库，并将下方克隆地址替换为自己的 Fork 地址。如果使用 nvm，可按示例运行 nvm use；使用其他版本管理器时，请先切换到所需的 Node.js 版本。

# 克隆项目
git clone https://github.com/emqx/MQTTX.git

cd MQTTX/web
nvm use
yarn install

# 编译和热重载以进行开发
yarn run serve

# 编译和压缩以构建生产版本
yarn run build

# 编译并启动一个本地 HTTP 服务器以进行测试
yarn run start

# 编译和压缩以构建生产版本，用于 Docker 容器化
yarn run build:docker

# 构建 Docker 镜像
docker build -t mqttx-web .

# 运行 Docker 镜像
docker run -p 80:80 mqttx-web

构建成功后，会在 dist 目录里出现构建成功的相应的文件。

修改配置

如果你需要进行个性化设置，比如修改默认的连接路径、部署路径或产物路径，你可以在 web/.env 或 web/.env.docker 文件中进行相应的修改。这两个文件分别对应了不同的打包需求，可以根据你的实际情况选择修改。

配置项	描述
VUE_APP_PAGE_TITLE	显示在浏览器的标题栏中的标题
VUE_APP_PAGE_DESCRIPTION	用于 SEO 的简短页面描述
VUE_APP_DEFAULT_HOST	MQTT 代理服务器连接的默认地址
BASE_URL	部署应用程序的根 URL，用于构建链接和路由
VUE_APP_OUTPUT_DIR	编译后将构建文件放置的目录

贡献

请确保在发出 PR 请求前， 已经仔细阅读过了贡献指南