From fb89d1ea415284c4e94fe15b3cde02fb36430682 Mon Sep 17 00:00:00 2001
From: pr <panharith-an@mptc.gov.kh>
Date: Wed, 17 Jan 2024 16:12:05 +0700
Subject: [PATCH] ES-692 Write technical document for signup service

Signed-off-by: pr <panharith-an@mptc.gov.kh>
---
 README.md                | 23 ++++++-----------------
 signup-service/README.md | 17 +++++++++++++----
 2 files changed, 19 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index e935e714..9cafdd76 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,14 @@
 
 signup-service is part of the esignet modules, but has a separate Helm chart so as to install and manage it in a completely independent namespace.
 
-## Build & run (for developers)
-The project requires JDK 11.
-1. Build and install:
-    ```
-    $ mvn clean install -Dgpg.skip=true
-    ```
-1. Build Docker for a service:
-    ```
-    $ docker build -f Dockerfile
-    ```
-
 ## Installing in k8s cluster using helm
 ### Pre-requisites
 1. Set the kube config file of the Mosip cluster having dependent services is set correctly in PC.
-1. Make sure [DB setup](db_scripts/README.md#install-in-existing-mosip-k8-cluster) is done.
-1. Add / merge below mentioned properties files into existing config branch:
-    * [signup-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/esignet-default.properties)
-    * [application-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/application-default.properties)
-1. Below are the dependent services required for signup service integrated with MOSIP IDA:
+2. Make sure [DB setup](db_scripts/README.md#install-in-existing-mosip-k8-cluster) is done.
+3. Add / merge below mentioned properties files into existing config branch:
+   * [signup-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/esignet-default.properties)
+   * [application-default.properties](https://github.com/mosip/mosip-config/blob/v1.2.0.1-B3/application-default.properties)
+4. Below are the dependent services required for signup service integrated with MOSIP IDA:
    | Chart | Chart version |
    |---|---|
    |[Keycloak](https://github.com/mosip/mosip-infra/tree/v1.2.0.1-B3/deployment/v3/external/iam) | 7.1.18 |
@@ -66,7 +55,7 @@ The project requires JDK 11.
   ```
 
 ## APIs
-API documentation is available [here](https://mosip.stoplight.io/docs/identity-provider/branches/main/6f1syzijynu40-identity-provider).
+API documentation is available [here](https://mosip.stoplight.io/docs/identity-provider/branches/signupV1/t9tvfbteqqokf-e-signet-signup-portal-ap-is).
 
 ## License
 This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
diff --git a/signup-service/README.md b/signup-service/README.md
index 5c70b86d..5448d813 100644
--- a/signup-service/README.md
+++ b/signup-service/README.md
@@ -1,6 +1,6 @@
 ## SignUp Service
 
-Signup service is a spring boot application with endpoints to 
+Signup service is a spring boot application with endpoints to
 
 1. Generate Challenge (Only OTP supported)
 2. Verify Challenge
@@ -12,7 +12,7 @@ Signup service connects to MOSIP IDRepo Identity service to register the verifie
 ID Repo identity service publishes the registered identity to MOSIP IDA. This enables authentication with the registered
 username and password with eSignet.
 
-Publishing registered/updated identity to MOSIP IDA is an async process. Hence, status endpoint is configured to check 
+Publishing registered/updated identity to MOSIP IDA is an async process. Hence, status endpoint is configured to check
 the latest status from server after every configured interval from signup UI.
 
 ### Signup service uses spring cache to store the transaction details.
@@ -42,7 +42,16 @@ The project requires JDK 11.
     ```
     $ mvn clean install -Dgpg.skip=true
     ```
-1. Build Docker for a service:
+2. Build Docker for a service:
     ```
     $ docker build -f Dockerfile
-    ```
\ No newline at end of file
+    ```
+3. Run with IntelliJ IDEA
+
+   3.1 Right click on parent POM file (pom.xml) and click on button "Add as Maven Project".
+
+   3.2 Download kernel-auth-adapter-1.2.1-es-SNAPSHOT.jar file from [here](https://oss.sonatype.org/#nexus-search;gav~io.mosip.kernel~kernel-auth-adapter~~~~kw,versionexpand).
+
+   3.3 Add that file to "signup-service" in Project Structure settings of IntelliJ, and Apply.
+
+   3.4 right click on file signup-service/src/main/java/io/mosip/signup/SignUpServiceApplication.java and click on Run