From 8f00c6667998546110db074763dc80932e682d27 Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Tue, 5 Nov 2024 14:01:51 +0530 Subject: [PATCH 1/5] MOSIP-33013 : Updated readme for developer guide java21 Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cabd364..da3bf66 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # digital-card-service -Service resposible to auto generate digital card once the registration packet is processed by registration processor module +Service responsible to auto generate digital card once the registration packet is processed by registration processor module + +## Build & run (for developers) +The project requires JDK 1.21. +and mvn version - 3.9.6 +1. Build and install: + ``` + $ cd kernel + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +### Add auth-adapter in a class-path to run a digital-card-service + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration files +Digital Card Service uses the following configuration files: +``` +application-default.properties +digital-card-default.properties +``` + +## Configuration +[Configuration-DigitalCard](https://github.com/mosip/mosip-config/blob/develop/digital-card-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here. + +Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. From a0d56d62541249da3461a1187d2cfcb02c16eb48 Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Fri, 8 Nov 2024 13:32:56 +0530 Subject: [PATCH 2/5] Update README.md Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index da3bf66..1d92c53 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,22 @@ # digital-card-service Service responsible to auto generate digital card once the registration packet is processed by registration processor module +## Databases +Refer to [SQL scripts](db_scripts). + ## Build & run (for developers) -The project requires JDK 1.21. +The project requires JDK 21.0 and mvn version - 3.9.6 1. Build and install: ``` $ cd kernel $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` - -### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration - ``` - hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect - ``` -This is for better compatibility with future PostgreSQL versions. - -### Configure ANT Path Matcher for Spring Boot 3.x compatibility. - ``` - spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER - ``` -This is to maintain compatibility with existing ANT-style path patterns. - -### Add auth-adapter in a class-path to run a digital-card-service - ``` - - io.mosip.kernel - kernel-auth-adapter - ${kernel.auth.adapter.version} - - ``` +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` ## Configuration files Digital Card Service uses the following configuration files: @@ -43,3 +30,12 @@ digital-card-default.properties [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here. Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. + +## Deploy +To deploy Commons services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). From 6ab3b83eaccd3dc863c932c61600cf1c560fa4fd Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Mon, 11 Nov 2024 13:20:08 +0530 Subject: [PATCH 3/5] updated config props and jdk versions Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1d92c53..c979e8c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Service responsible to auto generate digital card once the registration packet i Refer to [SQL scripts](db_scripts). ## Build & run (for developers) -The project requires JDK 21.0 +The project requires JDK 21.0.3 and mvn version - 3.9.6 1. Build and install: ``` @@ -19,15 +19,15 @@ and mvn version - 3.9.6 ``` ## Configuration files -Digital Card Service uses the following configuration files: +Digital Card Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master). ``` application-default.properties digital-card-default.properties ``` ## Configuration -[Configuration-DigitalCard](https://github.com/mosip/mosip-config/blob/develop/digital-card-default.properties) and -[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here. +[Configuration-DigitalCard](https://github.com/mosip/mosip-config/blob/master/digital-card-default.properties) and +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. @@ -35,7 +35,7 @@ Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configur To deploy Commons services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). ## APIs -API documentation is available [here](https://mosip.github.io/documentation/). +API documentation is available [here](https://mosip.github.io/documentation/1.2.0/1.2.0.html). ## License This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). From 6cc9ce6702e895e7d9928568ea5acc88345ec86e Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Mon, 11 Nov 2024 15:30:58 +0530 Subject: [PATCH 4/5] updated the configuration Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c979e8c..0efd60d 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ and mvn version - 3.9.6 ## Configuration files Digital Card Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master). +Please refer to the required released tagged version for configuration. ``` application-default.properties digital-card-default.properties From 8f2749975114c0f6896cfa3d050fbadb54f104c9 Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Mon, 11 Nov 2024 16:54:59 +0530 Subject: [PATCH 5/5] Update README.md Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0efd60d..a66203c 100644 --- a/README.md +++ b/README.md @@ -18,22 +18,16 @@ and mvn version - 3.9.6 $ docker build -f Dockerfile ``` -## Configuration files +## Configuration Digital Card Service uses the following configuration files that are accessible in this [repository](https://github.com/mosip/mosip-config/tree/master). Please refer to the required released tagged version for configuration. -``` -application-default.properties -digital-card-default.properties -``` - -## Configuration -[Configuration-DigitalCard](https://github.com/mosip/mosip-config/blob/master/digital-card-default.properties) and -[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here. +1. [Configuration-DigitalCard](https://github.com/mosip/mosip-config/blob/master/digital-card-default.properties) +2. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. ## Deploy -To deploy Commons services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). +To deploy digital-card-service on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). ## APIs API documentation is available [here](https://mosip.github.io/documentation/1.2.0/1.2.0.html).