{"id":22609073,"url":"https://github.com/bitfinexcom/bfx-report-ui","last_synced_at":"2025-04-11T06:19:52.086Z","repository":{"id":36447315,"uuid":"135130625","full_name":"bitfinexcom/bfx-report-ui","owner":"bitfinexcom","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-15T10:35:37.000Z","size":9250,"stargazers_count":11,"open_issues_count":0,"forks_count":22,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-16T10:46:56.726Z","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-28T08:14:42.000Z","updated_at":"2024-05-02T14:57:29.763Z","dependencies_parsed_at":"2023-02-17T13:15:47.741Z","dependency_job_id":"c0106fe0-863b-4254-baab-7c978e320900","html_url":"https://github.com/bitfinexcom/bfx-report-ui","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-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfinexcom","download_url":"https://codeload.github.com/bitfinexcom/bfx-report-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248352021,"owners_count":21089372,"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:48.089Z","updated_at":"2025-04-11T06:19:52.051Z","avatar_url":"https://github.com/bitfinexcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bfx-report-ui\n\nThe frontend of bfx-report at https://report.bitfinex.com\n\nYou can download the standalone electron version at [bfx-report-electron](https://github.com/bitfinexcom/bfx-report-electron)\n\nCheck `docs/` folder for more details.\n\n## Instructions (For development)\n\nRefer the first 2 steps from `bfx-report` project.\n\n1. Clone `bfx-report` project and do npm install.\n\n```\ngit clone https://github.com/bitfinexcom/bfx-report.git\nnpm install\n```\n\nIf you have installed `bfx-report` before, you might need to clean the npm cache to get the latest dependecy modules.\n\n```\nnpm cache clean --force\nnpm install\n```\n\n1.1. Copy all `config/**/*.json.example` to `config/**/*.json`\n\n1.2. Run the grenache worker with commands\n\nmanually run the 3 servers (in different terminal)\n\n    ```\n    grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'\n    grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'\n    npm run start\n    ```\n\nIf grape command is not available, install  `grenache-grape` globally via\n\n    `npm i -g grenache-grape`\n\n2. Clone `bfx-report-ui` project\n\n    ```\n    git clone https://github.com/bitfinexcom/bfx-report-ui.git\n    cd bfx-report-ui\n    npm install\n    ```\n\n2.1. Pull up the `bfx-report-express` submodule last changes and do npm install\n\n```\ngit submodule sync\ngit submodule update --init --recursive\ngit pull --recurse-submodules\ngit submodule update --remote\ncd bfx-report-express\nnpm install\n```\n\n2.1.1. Copy all `config/**/*.json.example` to `config/**/*.json`\n\n2.1.2. Run the express server with commands\n\n```\nnpm run start\n```\n\n2.2. start the report-ui\n\n    ```\n    npm run start\n    ```\n\nMake sure you have access permission to test with the staging server/API.\n\n## Web Token authentication\n\nWeb Token authentication will be used for site `https://report.bitfinex.com`.\n\nTo test web token authentication locally,\n\n1. Visit `https://www.bitfinex.com`, login and open web console, type `window.WSTOKEN` to copy the authToken.\n\n2. Start server locally via `npm start` and visit `http://localhost:3000/?authToken=pub:api:\u003ctoken string\u003e`, you'll auto login without enter auth secret and key.\n\nThe hosted version of report (https://report.bitfinex.com) will not allow access via API keys (for security reasons)\n\nhttps://report.bitfinex.com will be only accessible starting from https://www.bitfinex.com/report that will redirect the user to https://report.bitfinex.com/?authToken=pub:api:\u003ctoken string\u003e\n\n## Offline Query Mode (Sync Mode)\n\nBfx-report support sync user data to local machine and query offline. To enable that you need\n1. set `\"syncMode\": true` in bfx-report/config/service.report.json\n2. set `showSyncMode: true,` in bfx-report-ui/src/var/config.js\n\nThen run `npm start` and you will see the extra sync status button at top right side of the header.\n\n## 3rd party libraries\n\n* react/redux/redux-saga for core architecture\n* [re-ducks](https://github.com/alexnm/re-ducks)-like state structure\n* blueprintjs for ui framework http://blueprintjs.com\n* flexboxgrid2 for layout http://flexboxgrid.com/\n* [redux-persist] for local storage selected state\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfinexcom%2Fbfx-report-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report-ui/lists"}