/ open source

Open Banking Project API Set-up Locally on IntelliJ

Get the OBP-API codebase

mkdir -p ~/obpapi-demo-install
cd obpapi-demo-install/

git clone https://github.com/OpenBankProject/OBP-API.git
cd OBP-API/

# Create detault props settings, by copying the templates
cp src/main/resources/props/sample.props.template src/main/resources/props/default.props 

cp src/main/resources/props/test.default.props.template src/main/resources/props/test.default.props

Open IntelliJ

After you've downloaded the code, you can simply open the project in IntelliJ, by selecting the pom.xml in the root directory. This contains all project information needed for IntelliJ to build the project.
how-to-install-open-banking-api-intelliJ-step-2

Select the project pom.xml

how-to-install-open-banking-api-intelliJ-step-3

Select 'open as project':

how-to-install-open-banking-api-intelliJ-step-4

Rebuild the project:

This will take some time.
how-to-install-open-banking-api-intelliJ-step-5

Wait for successful build:

how-to-install-open-banking-api-intelliJ-step-6

Run Open Banking Project API (OBP-API) With IntelliJ

Navigate to src->test->scala, right click and choose "Run RunWebApp":

how-to-install-open-banking-api-intelliJ-step-7

This will cause the IntelliJ to build and run a test environment of OBP-API, via the Apache Jetty web server, listening on port 8080 by default. Visit http://127.0.0.1:8080 to verify:

how-to-install-open-banking-api-intelliJ-step-8

You can now play with your own OBP-API instance locally. Try creating an account.