From dfbb33530ffa8544468badabd1b8a74392fb9e89 Mon Sep 17 00:00:00 2001 From: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> Date: Tue, 12 Nov 2024 11:01:16 +0530 Subject: [PATCH] Merge pull request #756 from GOKULRAJ136/doc-1.3.x MOSIP-37256 : Updated ReadMe files for Java 21 Signed-off-by: GOKULRAJ136 <110164849+GOKULRAJ136@users.noreply.github.com> --- README.md | 15 +++++--- docs/configuration.md | 4 +- .../README.md | 34 ++++++++++------- .../README.md | 38 ++++++++++--------- 4 files changed, 53 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index ae351ed11aa..966892e1c61 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Pre-registration module consists of the following services: 5. Capthca ## Database -See [DB guide](db_scripts/README.md) +See [DB guide](db_scripts) ## Config-Server To run Pre-registration services, run [Config Server](https://docs.mosip.io/1.2.0/modules/module-configuration#config-server) @@ -20,13 +20,13 @@ To run Pre-registration services, run [Config Server](https://docs.mosip.io/1.2. ## Build & run (for developers) Prerequisites: 1. [Config Server](https://docs.mosip.io/1.2.0/modules/module-configuration#config-server) -1. JDK 21 and Java21 Artifactory Jars [here](https://oss.sonatype.org/content/repositories/snapshots/io/mosip/) -1. Build and install: +2. The project requires JDK 21.0.3 and mvn version - 3.9.6 +3. Build and install: ``` $ cd kernel $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` -1. Build Docker for a service: +4. Build Docker for a service: ``` $ cd $ docker build -f Dockerfile @@ -54,14 +54,17 @@ Prerequisites: $ ./restart.sh ``` +## Deploy +To deploy services on Kubernetes cluster using Dockers refer to [Sandbox Deployment](https://docs.mosip.io/1.2.0/deploymentnew/v3-installation). + ## Configuration Refer to the [configuration guide](docs/configuration.md). ## Test -Automated functional tests available in [Functional Tests repo](https://github.com/mosip/mosip-functional-tests). +Automated functional tests available in [Functional Tests repo](api-test). ## 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). diff --git a/docs/configuration.md b/docs/configuration.md index 72b1c3048cf..20afab1dab0 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,7 +1,9 @@ # Pre-registration Configuration Guide ## Property files -The configuration of the services is controlled by the following property files: +The configuration of the services is controlled by the following property 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.propertes` * `pre-registration-default.propertes` diff --git a/pre-registration/pre-registration-application-service/README.md b/pre-registration/pre-registration-application-service/README.md index e9250ee2c9a..fa5c847a4ca 100644 --- a/pre-registration/pre-registration-application-service/README.md +++ b/pre-registration/pre-registration-application-service/README.md @@ -9,20 +9,26 @@ This service manages to provide the following service to the Pre-registration ap * Notification- This service details used by Pre-Registration portal to trigger notification via SMS or email. * Login - This service details used by Pre-Registration portal to authenticate user by sending OTP to the user, validating with userid and OTP. -## Default Port and Context Path - - * server.port=9092 - * server.servlet.context-path=/preregistration/v1 - -## Swagger URL -* https://{dns-name}:9092/preregistration/v1/application-service/swagger-ui.html - -## Roles to Access the URL - -* INDIVIDUAL -* REGISTRATION_OFFICER -* REGISTRATION_SUPERVISOR -* REGISTRATION_ADMIN +## Build & run (for developers) +Prerequisites: +1. [Config Server](https://docs.mosip.io/1.2.0/modules/module-configuration#config-server) +2. The project requires JDK 21.0.3 and mvn version - 3.9.6 +3. Build and install: + ``` + $ cd kernel + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` +4. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + +## Configuration +The configuration of the services is controlled by the following property 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 +: +1. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) +2. [Configuration-Pre-Registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) ## API Dependencies diff --git a/pre-registration/pre-registration-datasync-service/README.md b/pre-registration/pre-registration-datasync-service/README.md index 99094224a4f..fe921af4c53 100644 --- a/pre-registration/pre-registration-datasync-service/README.md +++ b/pre-registration/pre-registration-datasync-service/README.md @@ -8,27 +8,31 @@ This service enables Pre-Registration to a registration client, request to retri [Design](https://github.com/mosip/pre-registration/blob/master/design/pre-registration/pre-registration-data-sync-service.md) +## Build & run (for developers) +Prerequisites: +1. [Config Server](https://docs.mosip.io/1.2.0/modules/module-configuration#config-server) +2. The project requires JDK 21.0.3 and mvn version - 3.9.6 +3. Build and install: + ``` + $ cd kernel + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` +4. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile -## Default Port and Context Path +## Configuration +The configuration of the services is controlled by the following property 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 +: +1. [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) +2. [Configuration-Pre-Registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) - * server.port=9094 - * server.servlet.context-path=/preregistration/v1 - - - -## URL - -* https://{dns-name}:9094/preregistration/v1/sync/swagger-ui.html - - -## Roles to Access the URL - -* REGISTRATION_OFFICER -* REGISTRATION_SUPERVISOR -* REGISTRATION_ ADMIN -* REGISTRATION_PROCESSOR +## APIs +API documentation is available [here](https://mosip.github.io/documentation/1.2.0/pre-registration-datasync-service.html). ## API Dependencies