Documentation · nurago

Your support helps keep this website running. Please consider supporting this project. SPONSOR DONATE

One guide per topic. Each links to the package pages it covers, and each package page carries the full package documentation with a runnable example.

Guides

Building a Production REST API in Go : a twenty-part guide, on tecnick.com, that builds a complete service on top of examples/service, from a bound socket to a deployment manifest.

The reference pages below answer “how do I do X”. The guide answers “why is the service shaped this way, and what happens when a request arrives”.

/docs/getting-started/ : installing the module, importing a package, and wiring a service lifecycle end to end.
/docs/service-scaffolding/ : generating a complete web service from project.cfg with make project.
/docs/dependency-footprint/ : what each import actually pulls into your build, and how to verify it.
/docs/observability/ : structured logging, the metrics contract and its backends, trace IDs, and log redaction.
/docs/resilience/ : retries, backoff and jitter, Retry-After, periodic work, and DNS caching.
/docs/security/ : password storage, breach checks, JWT authentication, encryption, and the endpoints to keep off the public internet.
/docs/data-and-messaging/ : SQL lifecycle and transactions, distributed locking, Redis, Valkey, Kafka, S3, and SQS.
/docs/testing/ : the test helpers, the generated mocks, and the QA pipeline.
/docs/migration-from-gogen/ : moving from the deprecated github.com/tecnickcom/gogen module path.
/docs/development/ : the Makefile workflow, linting, coverage, benchmarks, and the Docker build.
/docs/ai-assistants/ : using nurago with LLM coding assistants, llms.txt, and MCP documentation retrieval.