Skip to content

Commit

Permalink
format README
Browse files Browse the repository at this point in the history
Issue-ID: PORTALNG-123
  • Loading branch information
Fiete Ostkamp authored and Fiete Ostkamp committed Oct 22, 2024
1 parent e06b558 commit cead0f2
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Backend for Frontend (BFF) component of the portal-ng.

## Build
You can build and test the application with:

You can build and test the application with:

``` sh
# Windows
gradlew clean build
Expand All @@ -11,6 +13,7 @@ gradlew clean build
```

## Test

``` sh
# run all tests
./gradlew test
Expand All @@ -23,23 +26,29 @@ gradlew clean build
```

## Generate JAR

To generate one JAR file including also the open-api part the following command can be used

```sh
# generate JAR to /library/build/libs
./gradlew shadowJar
```

## Publish JAR

To publish the generated JAR file run

```sh
# publish JAR to target repository
./gradlew publish
```

## Run locally

Currently there are three spring profiles that can be used to run the application (`application.yml`, `application-local.yml` and `application-development.yml`).

To launch the application with a specific profile run

``` sh
SPRING_PROFILES_ACTIVE=local ./gradlew app:bootRun
# or
Expand All @@ -48,9 +57,11 @@ export SPRING_PROFILES_ACTIVE=local
```

## Development

You can run the service locally for evaluation or development purposes using the provided `docker-compose.yml` file in the development folder. This will launch a Keycloak and a Postgres db in the background.

To start the service execute the `run.sh` in the development folder:

```sh
development/run.sh
```
Expand All @@ -59,10 +70,11 @@ Example request against the preferences service can be run in your preferred IDE

You can access the Keycloak UI via browser.
URL: http://localhost:8080
**username:** admin
**username:** admin
**password:** password

To stop the preferences service, Keycloak and the databases run:

```sh
development/stop.sh
```

0 comments on commit cead0f2

Please sign in to comment.