Merge pull request #128 from GOKULRAJ136/doc-dev-21

MOSIP-37256 : Updated readme for developer guide java21

README.md

@@ -1,2 +1,36 @@
 # 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
+
+## Databases
+Refer to [SQL scripts](db_scripts).
+
+## Build & run (for developers)
+The project requires JDK 21.0.3
+and mvn version - 3.9.6
+1. Build and install:
+    ```
+    $ cd kernel
+    $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
+    ```
+2. Build Docker for a service:
+    ```
+    $ cd <service folder>
+    $ docker build -f Dockerfile
+    ```
+
+## 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.
+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 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).
+
+## License
+This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).