Skip to content

Commit

Permalink
[MOSIP-37358] readme
Browse files Browse the repository at this point in the history
Signed-off-by: JanardhanBS-SyncByte <[email protected]>
  • Loading branch information
JanardhanBS-SyncByte committed Nov 19, 2024
1 parent 14aa69c commit 9ba15dc
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Converters

# Overview

This repository contains the source code for the Converters module, which enables the conversion of ISO biometric and document data into standard image formats such as JPEG or PNG. The module exposes API endpoints for configuring and handling conversion operations.

## Build & run (for developers)

The project requires the following:
To build and run the project, ensure you have the following prerequisites installed:

- Java Development Kit (JDK): Version 21.0.5

Java Development Kit (JDK): Version 21.0.5
Maven: Version 3.9.6
- Apache Maven: Version 3.9.6

Follow these below steps to get started:

1. Build and install:
- Navigate to the project directory:
Expand Down Expand Up @@ -40,7 +44,7 @@ Swagger url: [Swagger UI](http://localhost:8098/v1/converter-service/swagger-ui/

4. Use the jar as library:

```maven
```xml
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-bio-converter</artifactId>
Expand All @@ -51,7 +55,13 @@ Swagger url: [Swagger UI](http://localhost:8098/v1/converter-service/swagger-ui/

# Docker Instructions

1. To build a Docker image for a specific service, navigate to the service folder:
Follow these steps to build a Docker image for a specific service:



1. Navigate to the service folder:

Use the cd command to move to the directory containing the desired service's Dockerfile.
```shell
$ cd <service folder>
Expand Down Expand Up @@ -103,6 +113,7 @@ Method: POST
## Response:
```json
{
"id": "sample-converter",
Expand Down

0 comments on commit 9ba15dc

Please sign in to comment.