https://github.com/bitfinexcom/bfx-report
https://github.com/bitfinexcom/bfx-report
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitfinexcom/bfx-report
- Owner: bitfinexcom
- License: apache-2.0
- Created: 2018-05-28T06:55:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T09:53:40.000Z (about 2 years ago)
- Last Synced: 2024-04-16T10:46:56.056Z (about 2 years ago)
- Language: JavaScript
- Size: 2.8 MB
- Stars: 7
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# bfx-report
## Setup
### Install
- Clone Github repository and install projects dependencies :
```console
git clone https://github.com/bitfinexcom/bfx-report.git
cd bfx-report
npm install
```
### Configure service
- As to configure the service copy the json.example files from config folder into new ones. Open a console on projects folder a copy the following codes :
```console
cp config/common.json.example config/common.json
cp config/service.report.json.example config/service.report.json
cp config/schedule.json.example config/schedule.json
cp config/facs/grc.config.json.example config/facs/grc.config.json
```
- To set grenache client for express, edit common.json. If running locally, leave actual values skipping this step.
```console
vim config/common.json
## set grenacheClient value
```
- To change the bitfinex api to connect to, edit `resUrl` in common.json. If you want to conect to main bitfinex api, skip this step, as this value is set by default.
```console
vim config/service.report.json
## set restUrl value
```
## Other Requirements
### Grenache network
- Install `Grenache Grape`: :
```console
npm i -g grenache-grape
```
- Run two Grapes
```console
grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'
grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'
```
## Run
### Production environment
- For production environment, run the worker in the console:
```console
npm run start
```
### Development environment
- For development environment, run the worker in the console:
```console
npm run startDev
```
## Testing
### Run tests
```console
npm test
```