22876cb7c3
commit 9b05ee5947709da1ed8dbfd2b17bf61d8d7cc4e3
Author: Simon Redfern <simon@tesobe.com>
Date: Sun Nov 15 23:37:25 2015 +0100
Clean up 6
commit 88965dede5c2e4dba57f00a1bc339fb4d9e48d08
Author: Simon Redfern <simon@tesobe.com>
Date: Sun Nov 15 23:31:07 2015 +0100
Clean up 5
commit 7a2fba3f3ce9a41b417472df961b0fcf09fcd0b9
Author: Simon Redfern <simon@tesobe.com>
Date: Sun Nov 15 23:25:19 2015 +0100
Clean up 3
commit 07436d3330e04e07deaf826465ad6cb9f50e6396
Author: Simon Redfern <simon@tesobe.com>
Date: Sun Nov 15 23:11:55 2015 +0100
Clean up 2
commit ca2e56ef1bdb5a23cca4b2005469c5292f6a94d7
Author: Simon Redfern <simon@tesobe.com>
Date: Sun Nov 15 23:05:45 2015 +0100
Clean up 1
|
||
|---|---|---|
| project | ||
| src | ||
| .gitignore | ||
| GNU_AFFERO_GPL_V3_19_Nov_1997.txt | ||
| Harmony_Individual_Contributor_Assignment_Agreement.txt | ||
| NOTICE | ||
| pom.xml | ||
| README.md | ||
Welcome to the OBP API Explorer
ABOUT
This application is used to explore the OBP API and interact with the data and services in the context of the logged in user.
LICENSE
This project is licensed under the AGPL V3 (see NOTICE) and a commercial license from TESOBE.
SETUP
The project is using sbt or Maven 3 as a build tool. See build.scala or pom.xml respectively for the dependencies.
To compile and run jetty, cd into the root directory (where this file is) and run:
$ sbt ...
compile ~;container:start; container:reload /
(Note that you first have to start sbt and then on its console start jetty with the container:start task, otherwise it will exit immediately. More here: https://github.com/siasia/xsbt-web-plugin/wiki)
In OS X, sbt can be installed with $ sudo port install sbt
Alternatively, maven can also be used:
mvn jetty:run
Note: You may need to add the pluginGroup to the $HOME/.m2/settings.xml
... org.mortbay.jetty ...
Ubuntu
If you use Ubuntu (or a derivate) and encrypted home directories (e.g. you have ~/.Private), you might run into the following error when the project is built:
uncaught exception during compilation: java.io.IOException
[ERROR] File name too long
[ERROR] two errors found
[DEBUG] Compilation failed (CompilerInterface)
The current workaround is to move the project directory onto a different partition, e.g. under /opt/ .
PROPS FILE
There is a props file template provided at src/main/resources/props/sample.props.template. It needs to be renamed and modified in order for the application to work.
- Renaming:
The sample.props.template file must be renamed for Lift to find it (https://www.assembla.com/wiki/show/liftweb/Properties). Renaming it to default.props should be the easiest way to get started.
base_url
The base_url is used to calculate the callback url to give to the Open Bank Project API server. This should just be the base url used to access the API Explorer. So if you're running a copy of the API Explorer at api-explorer.example.com over https, on the standard port, it would be "https://api-explorer.example.com". An example value for local development could be: http://127.0.0.1:8082 (8080 is the default Lift development port)
api_hostname
The api_hostname should be the base url of the Open Bank Project API. For example, https://api.openbankproject.com/api
obp_consumer_key obp_secret_key
The keys are obtained by registering as a developer on the Open Bank Project API server located at "api_hostname".
All in all, a props file could look something like:
api_hostname=https://api.openbankproject.com/api obp_consumer_key=uodsifnodsfifdsliufdsliufdsfdsfsdfsx obp_secret_key=iuesbfiyvglxzgifg7eisgei7fglesfi base_url=http://localhost:8082