Nuts node development
Go >= 1.18 is required.
Building for exotic environments
You can build and run the Nuts node on more exotic environments, e.g. Raspberry Pis:
32-bit ARMv6 (Raspberry Pi Zero):
env GOOS=linux GOARCH=arm GOARM=6 go build
Tests can be run by executing
go test ./...
Code generation is used for generating mocks, OpenAPI client- and servers, and gRPC services.
Make sure that
GOPATH/bin is available on
PATH and that the dependencies are installed
brew install protobufLinux:
apt install -y protobuf-compiler
Install Go tools:
To regenerate all code run the
run-generators target from the makefile or use one of the following for a specific group
Protobuf + gRCP
To generate the documentation, you’ll need to build a docker image and run it from the docs directory:
cd docs docker build -t nutsfoundation/nuts-node-docs . docker run --rm -v $PWD:/docs nutsfoundation/nuts-node-docs make html
The readme is auto-generated from a template and uses the documentation to fill in the blanks.
The documentation can be build by running the following command from the