Just use go build
.
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
Install protoc
:
MacOS:brew install protobuf
Linux:apt install -y protobuf-compiler
Install Go tools:
make install-tools
Generating code:
To regenerate all code run the run-generators
target from the makefile or use one of the following for a specific group
Group | Command |
---|---|
Mocks | make gen-mocks |
OpenApi | make gen-api |
Protobuf + gRCP | make gen-protobuf |
All | make run-generators |
The readme is auto-generated from a template and uses the documentation to fill in the blanks.
make gen-readme
The documentation can be build by running the following command from the /docs
directory:
make html