This guide will describe how to setup your environment to enable contribution to development.
a. Follow official golang installation guide. b. Use update-golang script.
Both options install golang to /usr/local/go. For everything to work correctly you must add path to go to your environment PATH variable. Add the following line to your $HOME/.profile file.
export PATH=$PATH:/usr/local/go/bin
(Restart may be needed for the changes in the .profile file to be applied). To test that go is setup correctly run in terminal:
go version
The command should succeed and print out the currently installed version of go.
Some parts of the hub repository are sensitive to location of the code. The source code of the repository must reside in your go workspace, at $HOME/go/src/plgd-dev/hub.
Manually create the folder structure and use git clone --recursive to download source code and all dependencies:
cd $HOME/go
mkdir -p src/github.com/plgd-dev
cd src/github.com/plgd-dev
git clone --recursive git@github.com:plgd-dev/hub.git
After a successful checkout use go mod download and go mod tidy commands to download dependencies.
cd $HOME/go/src/plgd-dev/hub
go mod download
go mod tidy
Execute the following command in terminal:
sudo apt install build-essential
Follow official docker installation guide.
Additionally, after succesfull docker installation you must allow non-root users to use docker. To do so follow Manage Docker as a non-root user guide.
Services use protobuf messages to communicate. To generate .pb files from .proto files protoc binary is used in Makefiles. To install latest protoc do the following steps:
.zip from https://github.com/protocolbuffers/protobuf/releases.zip file contains two folders: bin and include.
a) move the contents of the extracted bin folder to /usr/local/bin
b) move the contents of the extracted include folder to /usr/local/include0755 (read+write+execute for owner, read+execute for group and world)These steps are automated in convenience script hub/tools/install/install-latest-protoc.py.
To automatically generate API clients and server stubs in golang protoc plugins from gRPC-Gateway are used. To install them run:
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest;
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest;
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest;
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest;
go install github.com/favadi/protoc-go-inject-tag@latest;
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest;
yq is a tool for manipulating YAML files. It is used in Makefiles to set up environment variables. To install yq run:
go install github.com/mikefarah/yq/v4@latest
Set up sysctl to allow for more inotify watches and aio requests. Add the following lines to /etc/sysctl.conf:
fs.inotify.max_user_watches = 5242880
fs.aio-max-nr = 1048576
Your system should now be fully setup and capable of compiling all of the code in the repository.
Test go compilation by running unit tests:
make test
The command should succeed and execute all available unit test in the repository.
Test protobuf generation:
make proto/generate
To setup development environment run the following command:
make env
To clean development environment run the following command:
make clean
plgd makes it simpler to build a successful IoT initiative – to create a proof of concept, evaluate, optimize, and scale.
