Development

Development Guide

Use Git, Yarn, and Node.js 22 for development, matching .nvmrc. Check package.json and .nvmrc when switching branches. Familiarity with Vue.js, Electron, and TypeScript is recommended.

For contributions, fork the repository first and use your fork’s URL in the clone command. If you use nvm, run nvm use as shown below; otherwise, select the required Node.js version with your version manager.

# Clone the repository
git clone https://github.com/emqx/MQTTX.git

# Install dependencies
cd MQTTX
nvm use
yarn install

# Compile and hot reload for development
yarn run electron:serve

# Compile and compress to build a production version
yarn run electron:build

After the building is successful, the corresponding installation file for the successful building will appear in the dist_electron directory.

If you need to package it as an installation package for an independent operating system, please refer to the following command:

# For Windows
yarn run electron:build-win
# For Linux
yarn run electron:build-linux
# For macOS
yarn run electron:build-mac

Contributing

Please make sure to read the Contributing Guide before making a pull request.