Skip to content
Ggr

Contributing & development

To build Ggr:

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

  2. Clone Ggr source:

    Terminal window
    git clone https://github.com/WebSummoner/ggr.git

  3. Go to project directory:

    Terminal window
    cd ggr

  4. Build source:

    Terminal window
    go build

  5. Run Ggr:

    Terminal window
    ./ggr --help

Documentation

Section titled “Documentation”

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

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

Then open http://localhost:4321. To produce the static site exactly as CI does:

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

The build fails on dead internal links, so a green build is a link check. Pushing to master deploys automatically through the docs workflow.