Contributing & development

To build Ggr UI:

1. Install Go 1.27 or newer — the module declares go 1.27, so older toolchains cannot build it.

2. Clone Ggr UI source:

   git clone https://github.com/WebSummoner/ggr-ui.git

3. Go to project directory:

   cd ggr-ui

4. Build source:

   go build

   This will also automatically fetch dependencies.

5. Run Ggr UI:

   ./ggr-ui --help

Tip

To build Docker container type:

GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build
docker build -t ggr-ui:latest .

Documentation

These docs are an Astro Starlight site under docs-site/. Node is not required on your machine — run it in a container:

docker run --rm -it -v "$PWD/docs-site":/app -w /app -p 4321:4321 \
    node:24 sh -c 'npm install && npm run dev -- --host'

To produce the static site exactly as CI does:

docker run --rm -v "$PWD/docs-site":/app -w /app node:24 \
    sh -c 'npm ci && npm run build'