Build HyperDX in local

[firstsense]

Hello,

I would like to build HyperDX locally, We have implemented role based access for the Team Settings page. Need help in building it, I dont see the instructions in github README (https://github.com/hyperdxio/hyperdx)

Please help me to build it. Thanks in advance.

[tayfuryldz]

The build/development instructions have moved into CONTRIBUTING.md. On current main the supported local workflow is:

Prerequisites:

• Docker
• Node.js >= 22
• Yarn 4

From the repository root:

yarn install
yarn dev

(yarn dev is the important project command; if your checkout already has dependencies installed you can of course skip the install.)

The current dev task starts the Node API and Next.js frontend locally, with the OpenTelemetry collector and ClickHouse in Docker. It also starts the dev portal at:

http://localhost:9900

The portal shows the actual ports assigned to that worktree, so don't assume the frontend is on a fixed port.

To stop it:

yarn dev:down

For your Team Settings UI work, this is preferable to trying to manually build/start only the frontend because the page needs the backing services/API as well. The core services are hot-reloaded.

One Windows-specific detail from the current contribution guide: for WSL2, clone/run the repository inside the Linux filesystem (for example /home/<user>/hyperdx), not under /mnt/c, otherwise Next.js hot reload does not work correctly.

The exact current instructions are in the repository's CONTRIBUTING.md, under Development.