Skip to content

Commit

Permalink
MOSIP-37357 Corrected readme (#1025) (#1028)
Browse files Browse the repository at this point in the history
* MOSIP-37357 Corrected readme



* MOSIP-37357 Corrected java version



* MOSIP-37357 Corrected readme file



* MOSIP-37357 Corrected readme



* MOSIP-37357 Corrected readme



* MOSIP-37357 Corrected readme



* MOSIP-37357 Corrected readme



---------

Signed-off-by: kameshsr <kameshsr1338@gmail.com>
  • Loading branch information
kameshsr authored Nov 13, 2024
1 parent 1b45e6f commit abb4d37
Show file tree
Hide file tree
Showing 5 changed files with 182 additions and 3 deletions.
2 changes: 1 addition & 1 deletion authentication/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This code is moved to id-authentication repo and placed under the authentication-internal-service.
This code is moved to id-authentication repo and placed under the authentication-common.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This code is moved to id-authentication repo and placed under the authentication-internal-service.
This code is moved to id-authentication repo and placed under the authentication-common.
67 changes: 67 additions & 0 deletions pre-registration-booking-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,73 @@
## Overview
This service details used by Pre-Registration portal to book an appointment by providing his/her basic appointment details

## Databases
Refer to the required released tagged version [SQL scripts](https://github.com/mosip/pre-registration/tree/master/db_scripts).

## Build & run (for developers)
The project requires JDK 21.0.3
and mvn version - 3.9.6

1. Build and install:
```
$ cd pre-registration-booking-service
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Add auth-adapter in a class-path to run a master-data service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-ref-idobjectvalidator</artifactId>
<version>${kernel.ref.idobjectvalidator.version}</version>
</dependency>
```
## Configuration files
Pre-registration Service uses the following configuration files:
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
[Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here.
Refer to the required released tagged version.
Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service.
## Default context, path, port
Refer to [bootstrap properties](src/main/resources/bootstrap.properties)
## Deployment in K8 cluster with other MOSIP services:
### Pre-requisites
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
```
export KUBECONFIG=~/.kube/<k8s-cluster.config>
```
### Install
```
$ cd deploy
$ ./install.sh
```
### Delete
```
$ cd deploy
$ ./delete.sh
```
### Restart
```
$ cd deploy
$ ./restart.sh
```
## APIs
API documentation is available [here](https://mosip.github.io/documentation/).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# registration-processor-external-integration-service

## Overview
This service details used by Registration service for external integration service.

## Design
[Design - Approach for External System Integration](https://github.com/mosip/registration/blob/master/design/registration-processor/Approach_for_external_system_integration.md)

Expand All @@ -12,4 +15,55 @@ server.servlet.path=/registrationprocessor/v1/eis
```

## Operations done by the Service
1. It returns boolean value true for every non null requests
1. It returns boolean value true for every non-null requests

## Build & run (for developers)
The project requires JDK 21.0.3
and mvn version - 3.9.6

1. Build and install:
```
$ cd registration-processor\registration-processor-external-integration-service
$ 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 files
Registration processor external integration Service uses the following configuration files:
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here.
Refer to the required released tagged version.
Need to run the config-server along with the files mentioned above in order to run the registration processor external integration service.
## Deployment in K8 cluster with other MOSIP services:
### Pre-requisites
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
```
export KUBECONFIG=~/.kube/<k8s-cluster.config>
```
### Install
```
$ cd deploy
$ ./install.sh
```
### Delete
```
$ cd deploy
$ ./delete.sh
```
### Restart
```
$ cd deploy
$ ./restart.sh
```
## APIs
API documentation is available [here](https://mosip.github.io/documentation/).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# registration-processor-external-stage

## Overview
This stage integrates with external system for required external operations

## Design
Expand Down Expand Up @@ -30,3 +31,60 @@ mosip.regproc.external.server.servlet.path=/registrationprocessor/v1/external
```
## Operations in External stage
External validation by sending requests to external integration system

## Build & run (for developers)
The project requires JDK 21.0.3
and mvn version - 3.9.6

1. Build and install:
```
$ cd registration-processor\registration-processor-external-stage
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
```
### Add auth-adapter in a class-path to run a master-data service
```
<dependency>
<groupId>io.mosip.kernel</groupId>
<artifactId>kernel-auth-adapter</artifactId>
<version>${kernel.auth.adapter.version}</version>
</dependency>
```
## Configuration files
Registration processor external stage uses the following configuration files:
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and
[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here.
Refer to the required released tagged version.
Need to run the config-server along with the files mentioned above in order to run the registration processor external stage service.
## Deployment in K8 cluster with other MOSIP services:
### Pre-requisites
* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file:
```
export KUBECONFIG=~/.kube/<k8s-cluster.config>
```
### Install
```
$ cd deploy
$ ./install.sh
```
### Delete
```
$ cd deploy
$ ./delete.sh
```
### Restart
```
$ cd deploy
$ ./restart.sh
```
## License
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE).

0 comments on commit abb4d37

Please sign in to comment.