Welcome to the SOFIT

ABOUT

The Sofit application demonstrates some of the social aims behind the Open Bank Project:

Sliding scale of privacy and disclosure. e.g. Use aliases to protect real names but still show the flow of money.
Different views on account data (Public / Share holders / Team etc.) e.g. hide balances on public view.
Comment on transactions
Add other metadata e.g. tags / images to transactions / payees.

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 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

... 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/ .

To run Sofit with IntelliJ IDEA

Make sure you have the IntelliJ Scala plugin installed.
Create a new folder e.g. OpenBankProject and cd there
git clone https://github.com/OpenBankProject/Sofit.git
In IntelliJ IDEA do File -> New -> Project from existing sources, navigate to the folder, and select pom.xml
If you see a message about an unmanaged pom.xml, click the option to let Maven manage it.
There is a props file template provided at src/main/resource/prop/sample.props.template. It needs to be renamed and modified or just copy and paste with a new file name for the application to work. 7.These change will be performe in default.props file (/src/main/resources/props/default.props).

PROPS FILE

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.

Filling in values: (This step can skip)

transloadit.authkey transloadit.addImageTemplate

The Sofit app uses transloadit.com to process uploaded images. If these are not filling in, users will not be able to add images to individual transactions.

transloadit.authkey can be obtained by registering at transloadit.com transloadit.addImageTemplate can be obtained by creating a template at transloadit. A sample template that resizes images to 250px width is :

{ "steps": { "resize_to_250": { "robot": "/image/resize", "width": 250, "zoom": false } } }

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 social finance application. So if you're running a copy of the Sofit application at sofit.example.com over https, on the standard port, it would be "https://sofit.example.com". An example value for local development could be: http://localhost:8081 (as 8081 is the default Lift development port)

api_hostname

The api_hostname should be the base url (https://api.openbankproject.com) of the Open Bank Project API. If, Sofit is running locally then define api_hostname as http://127.0.0.1:8080 in your props file.

obp_consumer_key \

obp_secret_key

For the obp_consumer_key and obp_secret_key, should be run OBP-API in your local environment. Instruction are here for run OBP-API locally. In OBP-API, register as a user for Get API Key.

Note: In Redirect URL(Optional) give sofit base_url(http://localhost:8081/), when Register your consumer window will pop-up.

All in all, a props file could look something like:

transloadit.authkey=89hs8fho98fsho8hsf48sfo98sh
transloadit.addImageTemplate=s9fe8sh8h4sof98hf84s8fs48f4
api_hostname=https://api.openbankproject.com/api
defaultAuthProvider=https://api.openbankproject.com/api

OR

This is a for local envronment.
api_hostname=http://127.0.0.1:8080
defaultAuthProvider=http://127.0.0.1:8080

obp_consumer_key=uodsifnodsfifdsliufdsliufdsfdsfsdfsx
obp_secret_key=iuesbfiyvglxzgifg7eisgei7fglesfi
base_url=http://localhost:8080

limpins/Sofit