This repository contains the Protocol Buffer (.proto
) definitions used by ApexNova services, as well as the generated stub files for easy integration into your projects. These definitions are crucial for generating client and server code used for gRPC communication between services.
The repository is organized as follows:
proto/
|ββ service1/
β βββ service1.proto
|
|ββ service2/
β βββ service2.proto
|
βββ stub/
βββ stub_types.proto
stubs/
|ββ service1/
β βββ service1_stub/
|
βββ service2/
βββ service2_stub/
-
service1/
,service2/
: Directories containing.proto
files specific to a service and the corresponding generated stub files. The stub files are ready for integration into service-specific implementations. -
stub/
: Directory containing.proto
files for stub types used across different services.
To use these .proto
files and stub files in your project, you can either clone this repository or reference it directly if your build system supports remote dependencies.
To clone the repository, execute:
git clone https://github.com/apexnova-vc/proto.git
This will create a local copy of the repository, allowing you to explore and integrate the .proto
and stub files as needed.
If your build system supports it, you can directly reference the .proto
files and stub files in this repository. For example, in a Gradle project, you might use the following dependencies:
dependencies {
implementation 'com.apexnova:proto:<version>'
implementation 'com.apexnova:stub:<version>'
}
Be sure to replace <version>
with the specific version you want to use.
The stub files in this repository are generated from the .proto
files using Gradle. Hereβs a general outline of the process:
- Clone the Proto repository.
- Use Gradle to build the project, which will generate the stub files in the
stubs/
directory. - Integrate the generated stub files into your service implementations.
Example for building the project:
./gradlew build
Contributions to this repository are welcome. Please ensure that any changes to the .proto
files are backward compatible to avoid breaking changes in services that depend on these definitions.