Entwicklung
Stellen Sie sicher, dass Sie das Repository mit dem Flag
--recurse-submodules klonen oder fuehren Sie git submodule update --init --recursive aus, nachdem Sie das Repository bereits geklont haben.Dies ist erforderlich, damit die Livemap-Kacheln waehrend der Entwicklung bzw. beim Build verfuegbar sind.Erforderliche Werkzeuge
- Golang (Die Mindestversion finden Sie in der
go.mod-Datei)- Hinweise zur Installation von Go auf Ihrem System finden Sie in der Go-Installationsanleitung.
- Stellen Sie sicher, dass Ihr
PATH$GOPATH/binenthaelt, damit interne und automatisch installierte CLI-Tools korrekt funktionieren.
pnpm- Hinweise zur Installation von
pnpmauf Ihrem System finden Sie in der pnpm-Installationsanleitung.
- Hinweise zur Installation von
bufCLI- Installationsanweisungen fuer
buffinden Sie hier.
- Installationsanweisungen fuer
protoc-gen-doc- Wird automatisch installiert, wenn Sie
make gen-protoausfuehren. - Installieren Sie mit:
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
- Wird automatisch installiert, wenn Sie
go-licenses- Wird automatisch installiert, wenn Sie
make gen-licensesausfuehren. - Installieren Sie mit:
go install github.com/google/go-licenses@latest
- Wird automatisch installiert, wenn Sie
Codium/VSCode-Benutzer
- Benutzerdefinierte Einstellungen fuer Go-, JS/TS- und Vue-Formatierung sowie Linting sind im Repository im
.vscode-Ordner enthalten. Es wird empfohlen, diese Einstellungen fuer eine konsistente Entwicklungsumgebung zu verwenden. - Zusaetzlich ist im Repository eine
.editorconfig-Datei enthalten, um konsistente Codestile ueber verschiedene Editoren und IDEs hinweg sicherzustellen. Stellen Sie sicher, dass die EditorConfig-Unterstuetzung in Ihrem Editor aktiviert ist. - Eine Liste empfohlener Erweiterungen fuer VSCode/Codium finden Sie in der Datei .vscode/extensions.json.
GRPC API-Dokumentation
Die Seite "GRPC-Protobuf-Dokumentation" wird waehrend des Builds im CI-Workflow aus der gen/grpc-api.md-Datei des Haupt-Repositorys in den Dokumentations-Build uebernommen.
Sie bietet aktuelle Details zur API-Struktur und Nutzung.
