Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MOSIP-37256 : Updated ReadMe files for Java 21 #757

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ 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)

## 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 <service folder>
$ docker build -f Dockerfile
Expand Down Expand Up @@ -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).
Expand Down
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -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`

Expand Down
34 changes: 20 additions & 14 deletions pre-registration/pre-registration-application-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <service folder>
$ 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

Expand Down
38 changes: 21 additions & 17 deletions pre-registration/pre-registration-datasync-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <service folder>
$ 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

Expand Down
Loading