Skip to content
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

Jump to bottom

Format README #2

Closed
wants to merge 1 commit into from
Closed

Format README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
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
```
Loading