Bfx Reports Framework

Description

Bfx Reports Framework is a Reactjs and Nodejs open source framework with License Apache 2.0 for Bitfinex and Ethfinex users that can be used to build financial Reports.
When running the software the result is similar to what is hosted on https://www.bitfinex.com/reports
Including main structures and libraries gives the possibility for developers to create their personalized reports.

Bfx Reports Framework can be run by its own, without need of adding code, it already includes some exiting features not included on what is hosted on website.

Included Features

• All reports and tools from https://www.bitfinex.com/reports
• Possibility to work without a connection to internet.
• All ledgers and wallet values expressed in USD or other Forex currency

Composition

• https://github.com/bitfinexcom/bfx-report-ui UI components
• https://github.com/bitfinexcom/bfx-report-express Express server
• https://github.com/bitfinexcom/bfx-report Base from where back-end service extends from

Setup

Install

• Clone Github repository and install projects dependencies :

git clone https://github.com/bitfinexcom/bfx-reports-framework.git
cd bfx-facs-reports-framework
npm run init

• As to run framework on a network different that localhost, add to init the IP or URL as following:

./init.sh -i XX.XX.XX.XX (being XX.XX.XX.XX the ip)
or
./init.sh -u URL

Configure service

When running node init.sh configuration is done automatically.
As to check instructions of how to configure each component, visit the git repositories of the components listed above.

Other Requirements

Grenache network

• Install Grenache Grape: https://github.com/bitfinexcom/grenache-grape:

npm i -g grenache-grape

Run

As to run the software, is needed to run the network and services separately.

Run grenache network

• Run two Grapes

grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'
grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'

Run all framework services

• From main folder, run:

npm run start

Testing

Run tests

npm test