mirror of
https://github.com/openMF/community-app.git
synced 2026-02-06 11:36:48 +00:00
README updated - removed API_URL_OVERRIDE
This commit is contained in:
parent
c6a48b3226
commit
d9ce23c08d
34
README.md
34
README.md
@ -31,40 +31,12 @@ npm install -g grunt-cli
|
||||
You are done.
|
||||
|
||||
### Connecting to a MifosX Platform running on a different host:
|
||||
Out of the box, the UI will connect to the MifosX Platform running on the *same* host/port because
|
||||
the default value of API_URL_OVERRIDE is set to *false* in the configuration.js file.
|
||||
If you want to connect to a MifosX Platform running on a different host, e.g. the https://demo.openmf.org running in the cloud,
|
||||
then modify the configuration API_URL_OVERRIDE and HOST in
|
||||
```
|
||||
community-app\app\scripts\modules\configurations.js
|
||||
```
|
||||
|
||||
as below:
|
||||
|
||||
```
|
||||
.constant('API_URL_OVERRIDE', 'true')
|
||||
.constant('HOST','https://demo.openmf.org')
|
||||
.constant('API_VERSION','/mifosng-provider/api/v1')
|
||||
```
|
||||
|
||||
Similarly, to connect to a local server running on a different port than the web app on localhost, use:
|
||||
|
||||
```
|
||||
.constant('API_URL_OVERRIDE', 'true')
|
||||
.constant('HOST','https://localhost:8443\:8443') // need to escape port number
|
||||
```
|
||||
|
||||
Later, it may be possible to specify the baseApiUrl as part of the app's URL, watch
|
||||
|
||||
<a href="https://github.com/openMF/community-app/issues/199">Issue 199</a> (help/pull requests most welcome!).
|
||||
|
||||
By default, when the app is running in the local filesystem, it will connect to demo.openmf.org.
|
||||
By default, when the app is running in the local filesystem or on http://localhost, it will connect to demo.openmf.org.
|
||||
The UI will connect to the mifosng-provider REST API running on the same host/port when running in the cloud.
|
||||
|
||||
If you want to connect to the API running elsewhere, e.g. the https://xyz.org or https://localhost:8443,
|
||||
append the baseApiUrl as a query parameter.
|
||||
Ex:- /index.html?baseApiUrl=https://localhost:8443
|
||||
/index.html?baseApiUrl=https://xyz.org
|
||||
If you want to connect to the API running elsewhere, then append the baseApiUrl as a query parameter,
|
||||
e.g. http://localhost:9090/app/index.html?baseApiUrl=https://localhost:8443/#/.
|
||||
|
||||
## Adding dependencies
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user