mirror of
https://github.com/OpenBankProject/API-Explorer.git
synced 2026-02-06 18:56:49 +00:00
API Explorer for OBP API. A Scala / Liftweb applicaiton that consumes the OBP-API resource documentation so that developers can browse and interact with the OBP REST API enpoints.
| MavLift | ||
| .gitignore | ||
| README | ||
Open Bank Project README
This file only contains some notes regarding setup.
(A vagrant setup is in progress)
The project is using sbt or Maven 2 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
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
...
<pluginGroups>
<pluginGroup>org.mortbay.jetty</pluginGroup>
</pluginGroups>
...
</settings>
---
You need to install MongoDB and create an empty database called "OBP006".