meonkeys commented on code in PR #5051:
URL: https://github.com/apache/fineract/pull/5051#discussion_r2373631423


##########
README.md:
##########
@@ -69,6 +69,9 @@ Run the following commands:
 1. `./gradlew createDB -PdbName=fineract_default`
 1. `./gradlew devRun`
 
+Fineract is running at https://localhost:8443/fineract-provider/

Review Comment:
   I'd say that a bit differently. Suggestion:
   
   > Fineract is now running, and will be listening for API hits on port 8443 
by default.



##########
README.md:
##########
@@ -69,6 +69,9 @@ Run the following commands:
 1. `./gradlew createDB -PdbName=fineract_default`
 1. `./gradlew devRun`
 
+Fineract is running at https://localhost:8443/fineract-provider/
+
+Test the above endpoint with the headers: _fineract-platform-tenantid_ 
`default` and _Authorization_ `Basic bWlmb3M6cGFzc3dvcmQ=`

Review Comment:
   Let's give readers something they can copy & paste. `curl` is pretty 
standard for example API hit one-liners. Suggestion:
   
   > Confirm Fineract is ready with, for example:
   
   ```bash
   curl --insecure https://localhost:8443/fineract-provider/actuator/health
   ```
   
   > To test authenticated endpoints, include credentials in your request:
   
   ```bash
   curl --location \
     https://localhost:8443/fineract-provider/api/v1/clients \
     --header 'Content-Type: application/json' \
     --header 'Fineract-Platform-TenantId: default' \
     --header 'Authorization: Basic bWlmb3M6cGFzc3dvcmQ='
   ```



-- 
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]

Reply via email to