Skip to content

Commit

Permalink
docs: added Prerequisites and GH Credentials to README (#498)
Browse files Browse the repository at this point in the history
  • Loading branch information
manuraf authored Nov 27, 2024
1 parent 574d98a commit bc43661
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Microservice responsible for orchestrating the functionalities required for user dashboard activities. It retrieves institutions for a specific user by identifying their roles and permissions. It manages delegations related to an institution and technology partner and allows access to individual product back-office.

## Prerequisites

Java version: 17
Maven version: 3.9.*

## Required Configuration Properties

Before running you must set these properties as environment variables.
Expand All @@ -15,6 +20,26 @@ Before running you must set these properties as environment variables.
| backoffice.pago-pa.subscriptionKey<br/> | BACKOFFICE_PAGO_PA_API_KEY | | yes |
| jwt.signingKey<br/> <br/> | JWT_TOKEN_PUBLIC_KEY | | yes |

## Setup

### GitHub Credentials for selfcare-onboarding-sdk

To use the selfcare-onboarding-sdk, you need to configure your Maven settings to include GitHub credentials. This allows Maven to authenticate and download the required dependencies.

1. Open or create the ~/.m2/settings.xml file on your local machine.
2. Add the following <server> configuration to the <servers> section:

```xml script
<servers>
<server>
<id>selfcare-onboarding</id>
<username>**github_username**</username>
<password>**ghp_token**</password>
</server>
</servers>

```

## Running the application

You can run your application using:
Expand Down

0 comments on commit bc43661

Please sign in to comment.