https://github.com/hyvor/proto

.proto definitions for the internal gRPC APIs
https://github.com/hyvor/proto

Last synced: 13 days ago
JSON representation

.proto definitions for the internal gRPC APIs

• Host: GitHub
• URL: https://github.com/hyvor/proto
• Owner: hyvor
• Created: 2024-11-28T05:16:05.000Z (27 days ago)
• Default Branch: main
• Last Pushed: 2024-12-02T10:00:29.000Z (23 days ago)
• Last Synced: 2024-12-02T12:29:10.839Z (23 days ago)
• Language: PHP
• Size: 20.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
.proto definitions of HYVOR internal services

## Generating Code

Run `./generate.sh` to generate Go and PHP code from proto files.

## Usage

### Install as git submodule

To use these proto definitions in components, you can add this repository as a git submodule.

```bash

git submodule add https://github.com/hyvor/proto proto

```

To update the submodule, run:

```bash

git submodule update --remote proto

```

Or, simply call:

```bash

./proto/update

```

### Go Usage

Add the following line to your `go.mod` file to import the generated code.

```txt

replace hyvor/proto => ../proto/generated/go

```

### PHP Usage

Add the following line to your `composer.json` file to import the generated code.

```json

"repositories": [

    {

        "type": "path",

        "url": "./proto/generated/php"

    }

],

"require": {

    "hyvor/proto": "@dev"

}

```