MOSIP-37357 Corrected readme

Signed-off-by: kameshsr <[email protected]>
kameshsr · Nov 8, 2024 · 84cf382 · 84cf382
1 parent b7eff84
commit 84cf382
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -13,10 +13,12 @@ Partnermanagement module contains following services:
 Refer to [SQL scripts](db_scripts).
 
 ## Build & run (for developers)
-The project requires JDK 1.21. 
+The project requires JDK 1.21.
+and mvn version - 3.9.6
+
 1. Build and install:
     ```
-    $ cd kernel
+    $ cd partner
     $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
     ```
    
@@ -51,7 +53,7 @@ defined here.
    <dependency>
        <groupId>io.mosip.kernel</groupId>
        <artifactId>kernel-auth-adapter</artifactId>
-       <version>${kernel.auth.adaptor.version}</version>
+       <version>${kernel.auth.adapter.version}</version>
    </dependency>
    ```
 

diff --git a/partner/partner-management-service/README.md b/partner/partner-management-service/README.md
@@ -2,3 +2,47 @@
 
 This repository contains the source code for partner management service. For an overview refer [here](https://nayakrounak.gitbook.io/mosip-docs/modules/partner-management).
 
+## Build & run (for developers)
+The project requires JDK 1.21.
+and mvn version - 3.9.6
+
+1. Build and install:
+    ```
+    $ cd partner
+    $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
+    ```
+
+### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
+```
+mosip.datasource.authdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+mosip.datasource.regdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+```
+
+### For Spring-boot 3.x we need to specify the ANT Path Matcher for using the existing ANT path patterns.
+spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
+
+### Spring boot 3.x onwards we need to specify the below property to unmask values in actuator env url
+management.endpoint.env.show-values=ALWAYS
+
+1. Build Docker for a service:
+    ```
+    $ cd <service folder>
+    $ docker build -f Dockerfile
+    ```
+
+### Configuration
+[partner-management-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/partner-management-default.properties)
+
+[application-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/application-default.properties)
+
+defined here.
+
+### Add auth-adapter in a class-path to run a services
+   ```
+   <dependency>
+       <groupId>io.mosip.kernel</groupId>
+       <artifactId>kernel-auth-adapter</artifactId>
+       <version>${kernel.auth.adapter.version}</version>
+   </dependency>
+   ```
diff --git a/partner/policy-management-service/README.md b/partner/policy-management-service/README.md
@@ -2,3 +2,47 @@
 
 This repository contains the source code for policy management service. For an overview refer [here](https://nayakrounak.gitbook.io/mosip-docs/modules/partner-management).
 
+## Build & run (for developers)
+The project requires JDK 1.21.
+and mvn version - 3.9.6
+
+1. Build and install:
+    ```
+    $ cd partner
+    $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
+    ```
+
+### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration
+```
+mosip.datasource.authdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+mosip.datasource.regdevice.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+```
+
+### For Spring-boot 3.x we need to specify the ANT Path Matcher for using the existing ANT path patterns.
+spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER
+
+### Spring boot 3.x onwards we need to specify the below property to unmask values in actuator env url
+management.endpoint.env.show-values=ALWAYS
+
+1. Build Docker for a service:
+    ```
+    $ cd <service folder>
+    $ docker build -f Dockerfile
+    ```
+
+### Configuration
+[policy-management-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/policy-default.properties)
+
+[application-default.properties](https://github.com/mosip/mosip-config/blob/dev-integration/application-default.properties)
+
+defined here.
+
+### Add auth-adapter in a class-path to run a services
+   ```
+   <dependency>
+       <groupId>io.mosip.kernel</groupId>
+       <artifactId>kernel-auth-adapter</artifactId>
+       <version>${kernel.auth.adapter.version}</version>
+   </dependency>
+   ```