From f9cc8d017916fe235d0129d2beacd762b7c93453 Mon Sep 17 00:00:00 2001 From: Chetan Kumar Hirematha Date: Sat, 13 Dec 2025 17:34:35 +0530 Subject: [PATCH 1/4] [MOSIP-44051]: Updated README.md Signed-off-by: Chetan Kumar Hirematha --- biosdk-services/README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/biosdk-services/README.md b/biosdk-services/README.md index 728c95e..b1195cf 100644 --- a/biosdk-services/README.md +++ b/biosdk-services/README.md @@ -35,7 +35,7 @@ Ensure you have the following installed before proceeding: Clone the repository from GitHub to your local machine: -```bash +```text git clone https://github.com/mosip/biosdk-services.git cd biosdk-services ``` @@ -44,8 +44,8 @@ Clone the repository from GitHub to your local machine: Use Maven to build the project and resolve dependencies. -```bash - mvn clean install -Dgpg.skip=true +```text + mvn clean install -Dgpg.skip=true ``` @@ -54,13 +54,13 @@ Use Maven to build the project and resolve dependencies. Run the application using the following command: ```java -java -Dloader.path= -Dbiosdk_bioapi_impl= --add-modules=ALL-SYSTEM --add-opens java.xml/jdk.xml.internal=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.lang.stream=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED --add-opens java.base/java.time.LocalDate=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime.date=ALL-UNNAMED -jar biosdk-services-.jar + java -Dloader.path= -Dbiosdk_bioapi_impl= --add-modules=ALL-SYSTEM --add-opens java.xml/jdk.xml.internal=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.lang.stream=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED --add-opens java.base/java.time.LocalDate=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime.date=ALL-UNNAMED -jar biosdk-services-.jar ``` For example: ```java -java -Dloader.path=mock-sdk-1.3.0-SNAPSHOT-jar-with-dependencies.jar -Dbiosdk_bioapi_impl=io.mosip.mock.sdk.impl.SampleSDKV2 --add-modules=ALL-SYSTEM --add-opens java.xml/jdk.xml.internal=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.lang.stream=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED --add-opens java.base/java.time.LocalDate=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime.date=ALL-UNNAMED -jar biosdk-services-1.3.0-SNAPSHOT.jar + java -Dloader.path=mock-sdk-1.3.0-jar-with-dependencies.jar -Dbiosdk_bioapi_impl=io.mosip.mock.sdk.impl.SampleSDKV2 --add-modules=ALL-SYSTEM --add-opens java.xml/jdk.xml.internal=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.lang.stream=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED --add-opens java.base/java.time.LocalDate=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime=ALL-UNNAMED --add-opens java.base/java.time.LocalDateTime.date=ALL-UNNAMED -jar biosdk-services-1.3.0.jar ``` 4. **Verify the setup** @@ -102,7 +102,7 @@ Before building the image, set the following environment variables: Run the below command to build the Docker image: -```bash +```text docker build -t mosip/biosdk-services . ``` @@ -110,7 +110,7 @@ Run the below command to build the Docker image: Run the below command: -```bash +```text docker run -d -p 8080:8080 mosip/biosdk-services ``` @@ -122,14 +122,14 @@ Ensure the application is running correctly by following these steps: Use the docker ps command to verify that the container is up and running: -```bash +```text docker ps ``` * **Test the health endpoint:** Use curl to check the application's health: -```bash +```text curl http://localhost:9099/health ``` @@ -138,7 +138,7 @@ Use curl to check the application's health: If the setup is successful, you will see a response similar to below: ```text - Service is running... Fri Jan 29 08:49:28 UTC 2021 + Service is running... Fri Jan 29 08:49:28 UTC 2021 ``` --- @@ -188,7 +188,13 @@ In case of localhost: http://localhost:9099/biosdk-service/swagger-ui.html ``` --- +## Contribution & Community + +• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions). + +• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support. +• For any GitHub issues: [Report here](https://github.com/mosip/biosdk-services/issues) ## License This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/admin-services/blob/develop/LICENSE). From ca6024ca7270bf551938f157791ea9fb4c4357f1 Mon Sep 17 00:00:00 2001 From: Chetan Kumar Hirematha Date: Sat, 13 Dec 2025 17:36:33 +0530 Subject: [PATCH 2/4] [MOSIP-44051]: Updated README.md Signed-off-by: Chetan Kumar Hirematha --- biosdk-services/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/biosdk-services/README.md b/biosdk-services/README.md index b1195cf..c68237a 100644 --- a/biosdk-services/README.md +++ b/biosdk-services/README.md @@ -195,6 +195,7 @@ http://localhost:9099/biosdk-service/swagger-ui.html • If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support. • For any GitHub issues: [Report here](https://github.com/mosip/biosdk-services/issues) + ## License This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/admin-services/blob/develop/LICENSE). From 5bb4b2329431b02791bbb7c3561f7b938238ae18 Mon Sep 17 00:00:00 2001 From: Chetan Kumar Hirematha Date: Tue, 16 Dec 2025 20:14:04 +0530 Subject: [PATCH 3/4] [MOSIP-44051]: Updated Readme Signed-off-by: Chetan Kumar Hirematha --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 44878bc..161de3c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -[![Maven Package upon a push](https://github.com/mosip/biosdk-services/actions/workflows/push_trigger.yml/badge.svg?branch=develop-java21)](https://github.com/mosip/biosdk-services/actions/workflows/push_trigger.yml) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=develop-java21&project=mosip_biosdk-services&metric=alert_status)](https://sonarcloud.io/dashboard?branch=develop-java21&id=mosip_biosdk-services) - # Bio-SDK Service +[![Maven Package upon a push](https://github.com/mosip/biosdk-services/actions/workflows/push-trigger.yml/badge.svg?branch=develop)](https://github.com/mosip/biosdk-services/actions/workflows/push-trigger.yml) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?branch=develop&project=mosip_biosdk-services&id=mosip_biosdk-services&metric=alert_status)](https://sonarcloud.io/dashboard?branch=develop&id=mosip_biosdk-services) ## Overview This is reference service and provides a mock implementation of Bio-SDK REST Service. By default loads [Mock BIO SDK](https://github.com/mosip/mosip-mock-services/tree/master/mock-sdk) internally on the startup and exposes the endpoints to perform 1:1 match, extraction as per the [IBioAPIV2](https://github.com/mosip/bio-utils/blob/master/kernel-biometrics-api/src/main/java/io/mosip/kernel/biometrics/spi/IBioApiV2.java). From 3b9160c6f0c333692cf6da63e07b88c1a96e5b01 Mon Sep 17 00:00:00 2001 From: Chetan Kumar Hirematha Date: Tue, 16 Dec 2025 20:30:13 +0530 Subject: [PATCH 4/4] Update README with contribution and community info Added contribution guidelines and community support links. Signed-off-by: Chetan Kumar Hirematha --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 161de3c..8e169d8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ ## Overview This is reference service and provides a mock implementation of Bio-SDK REST Service. By default loads [Mock BIO SDK](https://github.com/mosip/mosip-mock-services/tree/master/mock-sdk) internally on the startup and exposes the endpoints to perform 1:1 match, extraction as per the [IBioAPIV2](https://github.com/mosip/bio-utils/blob/master/kernel-biometrics-api/src/main/java/io/mosip/kernel/biometrics/spi/IBioApiV2.java). +To know more about implementation, [refer here](biosdk-services/README.md). + +## Contribution & Community + +• To learn how you can contribute code to this application, [click here](https://docs.mosip.io/1.2.0/community/code-contributions). + +• If you have questions or encounter issues, visit the [MOSIP Community](https://community.mosip.io/) for support. + +• For any GitHub issues: [Report here](https://github.com/mosip/biosdk-services/issues) + To know more about Biometric SDK, refer [biometric-sdk](https://docs.mosip.io/1.2.0/biometrics/biometric-sdk). ### License