Contributing

Build

git clone https://github.com/AbolfazlTafakori/w-ui
cd w-ui/web && npm ci && npx vite build && cd ..
CGO_ENABLED=0 go build -o wui ./cmd/wui

The frontend is embedded into the binary, so build it first. Go 1.24+, Node 22+.

Run locally

WUI_DATA_DIR=./data WUI_LISTEN=127.0.0.1:2096 ./wui

On a machine without nftables the panel runs with enforcement reported as unavailable — every page works, limits are not applied.

For the frontend with hot reload: cd web && npm run dev proxies /api to the binary.

Test

go vet ./... && go test ./...
bash scripts/test-install-questions.sh install.sh
bash scripts/test-install-output.sh install.sh

CI runs those, staticcheck, govulncheck, a frontend build that must match the committed bundle, and a clean install on seven distributions.

Send a change

Open a pull request against main with what changed, why, and how it was tested. Keep the commit message in the style of the log: a sentence about what the change does for the operator.

Documentation

This site is docs/ — VitePress, English at the root and Persian under fa/. cd docs && npm ci && npm run dev. Every page exists in both languages; add both.