artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 15:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
simonredfern 2013-06-22 10:12:54 +03:00
parent 7e1f01b8f5
commit fca7d042ab
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -20,7 +20,7 @@ Please refer to the [wiki](https://github.com/OpenBankProject/OBP-API/wiki) to s
## STATUS
Currently most of the read only API calls are implemented.
[V1.2] (https://github.com/OpenBankProject/OBP-API/wiki/REST-API-V1.2) is mostly implemented
## LICENSE
@ -29,12 +29,14 @@ Some files (OAuth related) are licensed under the Apache 2 license.
## SETUP
We recommend to use the Vagrant and Puppet scripts available [here](https://github.com/OpenBankProject/OBP-VM) to create a Virtual Box VM running the Open Bank Project API.
Vagrant and Puppet scripts are available [here](https://github.com/OpenBankProject/OBP-VM) to create a Virtual Box VM running the Open Bank Project API.
Other wise the project is using sbt or Maven 2 as a build tool.
Otherwise use sbt or Maven 2 as a build tool.
----
SBT:
To compile and run jetty, cd into the "MavLift" directory and run:
$ sbt
@ -48,8 +50,8 @@ In OS X, sbt can be installed with $ sudo port install sbt
----
Alternatively, maven can also be used:
Maven:
mvn jetty:run
You need to install MongoDB and create an empty database called "OBP006".
Note: The default datastore for metadata is MongoDB. Postgres is used for user accounts.