blob: fa8de71f65092fb22804990e8c29471c110092f5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
# bff
Backend for Frontend (BFF) component of the portal-ng.
## Build
You can build and test the application with:
``` sh
# Windows
gradlew clean build
# Unix
./gradlew clean build
```
## Test
``` sh
# run all tests
./gradlew test
# run all tests in a test class
./gradlew test --tests GetTileIntegrationTest
# run individual test in a test class
./gradlew test --tests GetTileIntegrationTest.thatTileCanBeRetrieved
# run individual test in a test-class with debug info
./gradlew test --tests GetTileIntegrationTest.thatTileCanBeRetrieved --info
```
## 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 bootRun
# or
export SPRING_PROFILES_ACTIVE=local
./gradlew bootRun
```
## 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
```
Example request against the preferences service can be run in your preferred IDE with the `request.http` file from the development folder.
You can access the Keycloak UI via browser.
URL: http://localhost:8080
**username:** admin
**password:** password
To stop the preferences service, Keycloak and the databases run:
```sh
development/stop.sh
```
|
