ScoreTrak APIs

Protobuf files for ScoreTrak's APIs.

Prequesuites

You will need to have the following downloaded:

• protoc
• protoc-gen-go
• protoc-gen-grpc-web
• buf

Installation

Clone the repo

git clone https://github.com/ScoreTrak/scoretrakapis.git

Information

The go generated assets are currently in the Buf Generated Repository

go get go.buf.build/grpc/go/scoretrak/scoretrakapis

To generate other assets such as typescript, java, etc., create your own buf.gen.yaml file and execute buf gen.

An example with typescript:

1. Create your own buf.gen.yaml

# buf.gen.yaml
version: v1beta1
plugins:
    - name: grpc-web
      out: path/to/output
      opt: import_style=typescript,mode=grpcwebtext

2. Execute buf generate on the github reository (https://docs.buf.build/generate/usage#create-a-bufgenyaml)

buf generate --template ./buf.gen.yaml "https://github.com/scoretrak/scoretrakapis.git"

Usage

Lint proto files

buf lint

Generate files

buf generate