Development

Make sure to git clone the repository with --recurse-submodules flag or run git submodule update --init --recursive after you have already cloned the repository.This is required for the livemap tiles to be available during development/build.

Required Tooling

Golang (Minimum version can be found in the go.mod file)
- Check the Go installation guide for instructions on how to install Go on your system)
- Ensure your PATH includes $GOPATH/bin for proper functionality of internal and automatically installed cli tools.
pnpm
- Check the pnpm installation guide for instructions on how to install pnpm on your system.
buf Cli
- Installation instructions for buf can be found here.
protoc-gen-doc
- Is automatically installed when you run make gen-proto.
- Install using:
```
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
```
go-licenses
- Is automatically installed when you run make gen-licenses.
- Install using:
```
go install github.com/google/go-licenses@latest
```

Codium/VSCode Users

Custom settings for Go, JS/TS and Vue formatting and linting are included in the repository in the .vscode folder. It is recommended to use these settings for a consistent development experience.
Additionally a .editorconfig file is included in the repository to ensure consistent coding styles across different editors and IDEs. Make sure to enable EditorConfig support in your editor.
A list of recommended extensions for VSCode/Codium can be found in the .vscode/extensions.json file.

GRPC API Documentation

The "GRPC Protobuf Documentation" page is copied at build time in the CI workflow from the main repository's gen/grpc-api.md file during documentation build in the CI build workflow. It provides up-to-date details about the API structure and usage.

iOS App

GRPC Protobuf Documentation

Documentation for GRPC Protobuf files.