{"id":22609077,"url":"https://github.com/bitfinexcom/bfx-report","last_synced_at":"2025-04-11T06:20:11.456Z","repository":{"id":39420494,"uuid":"135121530","full_name":"bitfinexcom/bfx-report","owner":"bitfinexcom","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-16T09:53:40.000Z","size":2934,"stargazers_count":7,"open_issues_count":1,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-16T10:46:56.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitfinexcom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-28T06:55:13.000Z","updated_at":"2024-05-08T07:42:58.632Z","dependencies_parsed_at":"2023-09-23T03:43:25.363Z","dependency_job_id":"b62077ce-a1d0-41ec-bfdd-25c50ca5fbb7","html_url":"https://github.com/bitfinexcom/bfx-report","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfinexcom","download_url":"https://codeload.github.com/bitfinexcom/bfx-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248352139,"owners_count":21089387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-08T15:10:49.977Z","updated_at":"2025-04-11T06:20:11.422Z","avatar_url":"https://github.com/bitfinexcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bfx-report\n\n## Setup\n\n### Install\n\n- Clone Github repository and install projects dependencies :\n\n```console\ngit clone https://github.com/bitfinexcom/bfx-report.git\ncd bfx-report\nnpm install\n```\n\n### Configure service\n\n- 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 :\n\n```console\ncp config/common.json.example config/common.json\ncp config/service.report.json.example config/service.report.json\ncp config/schedule.json.example config/schedule.json\ncp config/facs/grc.config.json.example config/facs/grc.config.json\n```\n\n- To set grenache client for express, edit common.json. If running locally, leave actual values skipping this step.\n\n```console\nvim config/common.json\n## set grenacheClient value\n```\n\n- 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.\n\n```console\nvim config/service.report.json\n## set restUrl value\n```\n\n## Other Requirements\n\n### Grenache network\n\n- Install `Grenache Grape`: \u003chttps://github.com/bitfinexcom/grenache-grape\u003e:\n\n```console\nnpm i -g grenache-grape\n```\n\n- Run two Grapes\n\n```console\ngrape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'\ngrape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'\n```\n\n## Run\n\n### Production environment\n\n- For production environment, run the worker in the console:\n\n```console\nnpm run start\n```\n### Development environment\n\n- For development environment, run the worker in the console:\n\n```console\nnpm run startDev\n```\n\n\n## Testing\n\n### Run tests\n\n```console\nnpm test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfinexcom%2Fbfx-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report/lists"}