@dyteinternals/proto-entities
v2.110.5
Published
npm package which exports compiled protobuf entities to be used by other repos
Readme
Table of Contents
About The Project
Protocol buffer entities for the new media/room layer, along with autogenerated language wrappers.
Built With
- Node.js (>version 16)
- Go (>version 1.18)
- Protobuf Compiler
Getting Started
To get a local copy up and running follow these simple steps.
Installation
- Install NPM packages
npm i- Install the Protobuf Compiler
MacOS
brew install protobuf@3Linux
Ensure $PATH has .local
export PATH="$PATH:$HOME/.local/bin"Install protoc Linux
curl -LO https://github.com/protocolbuffers/protobuf/releases/download/v3.15.8/protoc-3.15.8-linux-x86_64.zip
unzip protoc-3.15.8-linux-x86_64.zip -d $HOME/.localMacos
curl -LO https://github.com/protocolbuffers/protobuf/releases/download/v25.3/protoc-25.3-osx-aarch_64.zip
unzip protoc-25.3-osx-aarch_64.zip -d $HOME/.local- Install golang packages
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
go install github.com/yoheimuta/protolint/cmd/protolint@latestUpdate Proto
Make the necessary updates to .proto files adding, updating, deleting new messages
Lint
Before building, protobuf files are linted to ensure they meet the required standards. This is achieved by running
make lintBuild
This step compiles the protobuf files into the desired language-specific wrappers.
make buildVersion History
See CHANGELOG.
Support
(Ask for support or sponsorships by providing links or just add a simple message)
Contributions, issues, and feature requests are welcome! Give a ⭐️ if you like this project!
License
Distributed under the Apache License, Version 2.0. See LICENSE for more information.
About
proto-entities is created & maintained by Dyte, Inc. You can find us on Twitter - @dyte_io or write to us at dev [at] dyte.io.
The names and logos for Dyte are trademarks of Dyte, Inc.
We love open source software! See our other projects and our products.
