protobuf

v-bible protobuf schema

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• Getting Started
  • Prerequisites
  • Run Locally
• Usage
  • Protobuf References
  • Makefile Targets
  • Swagger UI
• Contributing
  • Code of Conduct
• License
• Contact
• Acknowledgements

🧰 Getting Started

‼️ Prerequisites

• asdf environment: Please setup asdf to install corresponding dependencies specified in .tool-versions file.

  • nodejs: https://github.com/asdf-vm/asdf-nodejs.git.
  • golang: https://github.com/asdf-community/asdf-golang.git.

🏃 Run Locally

Clone the project:

git clone https://github.com/v-bible/protobuf.git

Go to the project directory:

cd protobuf

Install dependencies:

go mod download

👀 Usage

Protobuf References

Please go to file docs/proto_references.md for more information about protobuf references.

Makefile Targets

• gen-proto: generate protobuf files.

make gen-proto

Swagger UI

Run the following command to start the Swagger UI:

docker-compose up

Then, open your browser and go to http://localhost:8080.

Note

If you add more service please update the docker-compose.yml file.

👋 Contributing

Contributions are always welcome!

Please read the contribution guidelines.

📜 Code of Conduct

Please read the Code of Conduct.

⚠️ License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License.

.

See the LICENSE.md file for full details.

🤝 Contact

Duong Vinh - @duckymomo20012 - tienvinh.duong4@gmail.com

Project Link: https://github.com/v-bible/protobuf.

💎 Acknowledgements

Here are useful resources and libraries that we have used in our projects:

• grpc-gateway: gRPC to JSON proxy generator following the gRPC HTTP spec.
• buf.build: A new way to work with Protocol Buffers.
• Swagger UI: The Swagger UI is an open source project to visually render documentation for an API defined with the OpenAPI (Swagger) Specification.