Skip to content

fix: update README.md file for gradle instructions #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
asingh04 wants to merge 3 commits into from
Closed

fix: update README.md file for gradle instructions #185

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4792767
fix: update README.md file for gradle instructions
asingh04 May 23, 2025
ff93096
fix: update README.md file for gradle instructions
asingh04 May 23, 2025
3760de0
fix: add directory info of generated source for gradle
asingh04 May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Define a `.proto` service definition file `src/main/proto/hello.proto` with the
syntax = "proto3";

option java_multiple_files = true;
option java_package = "org.springframework.grpc.sample.proto";
option java_package = "org.springframework.grpc.sample.proto"; // !IMP: change the package name to the one you mentioned in spring initilizr
option java_outer_classname = "HelloWorldProto";

// The greeting service definition.
Expand Down Expand Up @@ -58,7 +58,9 @@ or
./gradlew build
```

You’ll get two new folders in the `target` directory (or `build` for Gradle): `target/target/generated-sources/protobuf/grpc-java` and `target/target/generated-sources/protobuf/java`. You may need to instruct your IDE to mark them as source roots. In IntelliJ IDEA, you’d right click the folder, choose `Mark Directory As` -> `Generated Source Root`. Eclipse or VSCode will add them automatically for you.
You’ll get two new folders in the `target` directory: `target/target/generated-sources/protobuf/grpc-java` and `target/target/generated-sources/protobuf/java`.
(_For gradle_, refer the `build` directory: `build/generated/source/proto/main/grpc` & `build/generated/source/proto/main/java`)
You may need to instruct your IDE to mark them as source roots. In IntelliJ IDEA, you’d right-click the folder, choose `Mark Directory As` -> `Generated Source Root`. Eclipse or VSCode will add them automatically for you.

Now you can implement a service based on the generated stubs:

Expand Down Expand Up @@ -112,7 +114,7 @@ Run the program in the usual way:
or

```shell
./gradle bootRun
./gradlew bootRun
```

You can try it out using a gRPC client like `grpcurl`:
Expand Down