From 495d14b48d31481f85ae8ddb79128c97cd75d977 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Mon, 20 Jan 2025 17:57:32 -0600 Subject: [PATCH] Fix getting-started.adoc steps Updates the fix-getting-started.adoc section of the reference guide to remove the requirement of the "web" and "graalvm" dependencies as the former requires other information besides dependencies to work properly and the latter is just complication that is not needed for a simple quick start. See #97 --- README.md | 8 +++++++- .../main/antora/modules/ROOT/pages/getting-started.adoc | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3235cc4..5a3581d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,13 @@ For further information go to our [Spring gRPC reference documentation](https:// This section offers jumping off points for how to get started using Spring gRPC. There is a simple sample project in the `samples` directory (e.g. [`grpc-server`](https://github.com/spring-projects-experimental/spring-grpc/tree/main/samples/grpc-server)). You can run it with `mvn spring-boot:run` or `gradle bootRun`. You will see the following code in that sample. -Want to get started? Let’s speedrun a working service. Go to the [Spring Initializr](https://start.spring.io), select `gRPC`, `Web`, and `GraalVM`. Both Apache Maven and Gradle should work. Download the `.zip` file and unzip it. Open it in your IDE in the usual way. E.g. if you’re using IntelliJ IDEA: `idea pom.xml`; or for VSCode `code .`. +Want to get started? Let’s speedrun a working service. + +Go to the [Spring Initializr](https://start.spring.io) and select the `gRPC` dependency. + +Generate the project and unzip the downloaded result. + +Open it in your IDE in the usual way. E.g. if you’re using IntelliJ IDEA: `idea pom.xml`; or for VSCode `code .`. Define a `.proto` service definition file `src/main/proto/hello.proto` with the following contents: diff --git a/spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc b/spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc index a1c3ee0..3f03e10 100644 --- a/spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc +++ b/spring-grpc-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc @@ -3,7 +3,13 @@ This section offers jumping off points for how to get started using Spring gRPC. There is a simple sample project in the `samples` directory (e.g. https://github.com/spring-projects-experimental/spring-grpc/tree/main/samples/grpc-server[`grpc-server`]). You can run it with `mvn spring-boot:run` or `gradle bootRun`. You will see the following code in that sample. -Want to get started? Let's speedrun a working service. Go to the [Spring Initializr](https://start.spring.io), select `gRPC`, `Web`, and `GraalVM`. Both Apache Maven and Gradle should work. Download the `.zip` file and unzip it. Open it in your IDE in the usual way. E.g. if you're using IntelliJ IDEA: `idea pom.xml`; or for VSCode `code .`. +Want to get started? Let's speedrun a working service. + +Go to the https://start.spring.io[Spring Initializr] and select the `gRPC` dependency. + +Generate the project and unzip the downloaded result. + +Open it in your IDE in the usual way. E.g. if you're using IntelliJ IDEA: `idea pom.xml`; or for VSCode `code .`. Define a `.proto` service definition file `src/main/proto/hello.proto` with the following contents: