paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 51 Packages Projects Releases Wiki Activity

move install instructions to readme + move docker-compose

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-02-24 11:01:14 +01:00
parent 5925221658
commit 8c9b04b240
7 changed files with 63 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
proto/README.md
+10 -8
View File
@@ -4,19 +4,21 @@ Collection of all Backstage protobuf definitions.
## Usage
Managed with [Prototool](https://github.com/uber/prototool), install instructions at <https://github.com/uber/prototool/blob/dev/docs/install.md>
Prodobuf definitions are managed with [Prototool](https://github.com/uber/prototool).
## Install Dependencies
## Installing Dependencies
### Prototool
```bash
$ brew install prototool
```
See [installation instructions](https://github.com/uber/prototool/blob/dev/docs/install.md). On MacOS you can use `brew install prototool`.
### Go
You will need to have Go installed, along with a properly set up `GOPATH` and `$GOPATH/bin` added to your `PATH`, follow the instructions [here](https://golang.org/doc/install#install).
### protoc-gen-go
This will enable code generation in Go for interacting with gRPC-Web. You will need to have `protoc-gen-go` available in your path. You can find out more information here: https://github.com/golang/protobuf
This will enable code generation for Go. You will need to have `protoc-gen-go` available in your path. You can find out more information here: https://github.com/golang/protobuf
```bash
$ go get -u github.com/golang/protobuf/protoc-gen-go
@@ -31,10 +33,10 @@ Installation instructions are found at https://github.com/grpc/grpc-web#code-gen
## Generating Code
To generate the Protobuf definitions in Go and TypeScript, run the following command from the root with [Prototool](https://github.com/uber/prototool):
To generate the Protobuf definitions in Go and TypeScript, run the following command inside the `proto/` directory with [Prototool](https://github.com/uber/prototool):
```bash
$ prototool generate ./proto
$ prototool generate
```
This will generate the respective "generated" files in the following folders: