Skip to content

Commit a56aa4d

Browse files
authored
Chore/sample app readme update (#125)
* Update Sample Code Readme * F * Fix typo
1 parent b029eac commit a56aa4d

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

sample-code/spring-app/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,25 @@
55
Sample code to demonstrate the usage of the SAP AI SDK.
66
Also used as basis for running E2E tests.
77

8-
## Build, Run, Deploy Locally
8+
## Build and Run the Sample App
99

10-
Build the project with:
10+
Before you can run the sample app, you need to install the AI SDK into your local Maven repository:
1111

12-
1. `mvn compile`
13-
2. [Download a service key for your AI Core service instance](../../README.md#set-credentials-as-dedicated-environment-variable)
14-
3. Create the environment variable `AICORE_SERVICE_KEY`
15-
4. Run the application with `mvn spring-boot:run`
16-
5. [See all available endpoints](localhost:8080)
12+
* Run `mvn install -DskipTests` from the root directory of the repository.
13+
14+
> [!NOTE]
15+
> The sample app uses the latest state of the SDK, so make sure to install the SDK after pulling a new version via Git.
16+
> Alternatively, you check out one of the release tags of the repository, e.g. `git fetch --all --tags && git checkout rel/0.1.0`.
17+
18+
Next, you'll need to set up credentials for the AI Core service:
19+
20+
* Follow [these instructions](../../README.md#option-1-set-credentials-as-environment-variable) to configure the credentials via environment variables.
21+
22+
Finally, you can start the sample app:
23+
24+
* Run `mvn spring-boot:run` from the sample app directory.
25+
26+
Head to http://localhost:8080 in your browser to see all available endpoints.
1727

1828
## Run the E2E Test
1929

0 commit comments

Comments
 (0)