meonkeys commented on code in PR #5051: URL: https://github.com/apache/fineract/pull/5051#discussion_r2377065170
########## README.md: ########## @@ -69,6 +69,20 @@ Run the following commands: 1. `./gradlew createDB -PdbName=fineract_default` 1. `./gradlew devRun` +Fineract is now running, and will be listening for API requests on port 8443 by default. + +Confirm Fineract is ready to receive requests with the endpoint: + +`curl --insecure https://localhost:8443/fineract-provider/actuator/health` Review Comment: Please use [fenced Bash code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) for both these curl commands. See the "Unit tests" and "Integration tests" parts of this same readme for examples. ########## README.md: ########## @@ -69,6 +69,20 @@ Run the following commands: 1. `./gradlew createDB -PdbName=fineract_default` 1. `./gradlew devRun` +Fineract is now running, and will be listening for API requests on port 8443 by default. + +Confirm Fineract is ready to receive requests with the endpoint: + +`curl --insecure https://localhost:8443/fineract-provider/actuator/health` + +To test authenticated endpoints, include credentials in your request: + +`curl --location \ +https://localhost:8443/fineract-provider/api/v1/clients \ +--header 'Content-Type: application/json' \ +--header 'Fineract-Platform-TenantId: default' \ +--header 'Authorization: Basic bWlmb3M6cGFzc3dvcmQ='` Review Comment: Fenced code block here too (also with `bash` hint). First line of this example should be left-justified, subsequent lines should be indented two spaces, please. ########## README.md: ########## @@ -69,6 +69,20 @@ Run the following commands: 1. `./gradlew createDB -PdbName=fineract_default` 1. `./gradlew devRun` +Fineract is now running, and will be listening for API requests on port 8443 by default. + +Confirm Fineract is ready to receive requests with the endpoint: Review Comment: "Confirm Fineract is ready with, for example:" makes more sense here. An example API request using curl is what follows, not an endpoint. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
