1
1
## protobuf-project template
2
2
3
- This is a repository template for projects using protobuf.
3
+ This template uses [ protobuf-go-lite ] to generate reflection-free Go code and [ protobuf-es-lite ] for TypeScript interfaces .
4
4
5
- Supports ** Go and TypeScript** with Go-style import paths.
5
+ [ protobuf-go-lite ] : https://github.com/aperturerobotics/protobuf-go-lite
6
+ [ protobuf-es-lite ] : https://github.com/aperturerobotics/protobuf-es-lite
6
7
7
8
Uses a Makefile to download tools to ./hack/bin.
8
9
@@ -12,6 +13,10 @@ You can create a new repository with this template [on GitHub].
12
13
13
14
[ on GitHub ] : https://github.com/aperturerobotics/protobuf-project
14
15
16
+ Also check out the managed template at [ template] .
17
+
18
+ [ template ] : https://github.com/aperturerobotics/template
19
+
15
20
## Usage
16
21
17
22
Protobuf imports use Go paths and package names:
@@ -44,7 +49,7 @@ The Makefile will download the tools using Go to a bin dir.
44
49
45
50
The available make targets are:
46
51
47
- - ` gengo ` : Generate protobuf files.
52
+ - ` genproto ` : Generate protobuf files.
48
53
- ` test ` : run go test -v ./...
49
54
- ` lint ` : run golangci-lint on the project.
50
55
- ` fix ` : run golangci-lint --fix on the project.
@@ -71,12 +76,6 @@ Other available branches:
71
76
[ starpc ] : https://github.com/aperturerobotics/starpc
72
77
[ Twirp ] : https://github.com/twitchtv/twirp
73
78
74
- ** starpc** is the only RPC library currently to support bidirectional RPC streams in the web browser over WebSocket or other two-way channels.
75
-
76
- [ protobuf-go-lite] is used with starpc to support reflection-free protobufs.
77
-
78
- [ protobuf-go-lite ] : https://github.com/aperturerobotics/protobuf-go-lite
79
-
80
79
## Demo
81
80
82
81
** This branch implements a starpc service and demo.**
0 commit comments