{"id":22608981,"url":"https://github.com/bitfinexcom/bfx-report-electron","last_synced_at":"2026-04-08T13:02:01.099Z","repository":{"id":35813492,"uuid":"136324251","full_name":"bitfinexcom/bfx-report-electron","owner":"bitfinexcom","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-17T12:24:26.000Z","size":6173,"stargazers_count":26,"open_issues_count":89,"forks_count":15,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-03-18T01:51:49.483Z","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":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-06-06T12:16:52.000Z","updated_at":"2026-03-17T12:24:37.000Z","dependencies_parsed_at":"2026-03-17T13:04:47.995Z","dependency_job_id":null,"html_url":"https://github.com/bitfinexcom/bfx-report-electron","commit_stats":null,"previous_names":[],"tags_count":93,"template":false,"template_full_name":null,"purl":"pkg:github/bitfinexcom/bfx-report-electron","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-electron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-electron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-electron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-electron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfinexcom","download_url":"https://codeload.github.com/bitfinexcom/bfx-report-electron/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-report-electron/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31556239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T10:21:54.569Z","status":"ssl_error","status_checked_at":"2026-04-08T10:21:38.171Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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:26.231Z","updated_at":"2026-04-08T13:02:01.081Z","avatar_url":"https://github.com/bitfinexcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bfx-report-electron\n\n## Binaries\n\nAlready complied binaries can be found on release section [release section](https://github.com/bitfinexcom/bfx-report-electron/releases)\n\nDownload the correspondent binary according your operating system. Available the following binaries:\n\n- `AppImages` for the Linux\n- zipped `DMG` for the MacOS\n- `NSIS` installer for the Windows\n\n### I get some errors related to something called “FUSE”\n\n\u003e AppImages require a Linux technology called Filesystem in Userspace (or short FUSE). The majority of systems ships with a working FUSE setup. However, sometimes, it doesn’t quite work. [This section explains](https://docs.appimage.org/user-guide/troubleshooting/fuse.html) a few solutions that fix the most frequently reported problems.\n\n## Setup\n\nFunctionality has been tested on `Ubuntu 22.04 LTS`\n\n### Main Structure\n\nTo simplify setup/build/publish processes the following bash scripts are provided:\n\n- `./scripts/setup.sh` - CLI as an easy way to get through the setup process. It will launch `./scripts/sync-repo.sh` script and then setup the development environment\n- `./scripts/sync-repo.sh` - CLI to fetch the last changes of the repository/sub-modules from the main remote repo\n- `./scripts/launch.sh` - CLI to launch Docker Compose services to build releases and publish executable artifacts of the electron app with the last fetched changes\n\nAdditional bash scripts:\n\n- `./scripts/build-release.sh` - CLI as the entrypoint to start the build release process, uses in the docker container, but can be used independently\n- `./scripts/build-ui.sh` - CLI as the entrypoint to start the build UI process, uses in the docker container, but can be used independently\n- `./scripts/helpers` - folder with addition bash functions\n- `./scripts/node` - folder with addition NodeJS scripts\n\n### Requirements\n\nThe setup was tested with the following dependencies:\n\n- Docker version 24.0.6\n- Docker Compose version 2.21.0\n- git version 2.24.1\n\nTo install `Docker`/`Docker Compose` check the corresponding sections of the official docs:\n\n- [install Docker](https://docs.docker.com/engine/install)\n- [install Docker Compose](https://docs.docker.com/compose/install) Compose V2 is included with all currently supported versions of Docker Desktop\n- if you don’t want to preface the docker command with sudo, create a Unix group called docker and add users to it, [check the doc](https://docs.docker.com/engine/install/linux-postinstall)\n\n### Setup electron app\n\nAfter cloning the repository there's needed to configure the app. For it can be used `./scripts/setup.sh` bash script.\nAvailable the following arguments:\n\n```console\n./scripts/setup.sh -h\n\nUsage: ./scripts/setup.sh [options] [-h]\n\nOptions:\n  -r    Sync all repositories\n  -o    Sync only sub-modules\n  -s    Use staging BFX API\n  -d    Set development environment\n  -u    Turn off auto-update\n  -h    Display help\n```\n\nAlso there will be executed the following steps:\n\n- setup backend configs\n- install all backend dependencies\n- setup and build the UI static files\n\nTo launch `./scripts/setup.sh` script also can be used the following NPM script:\n\n```console\nnpm run setup -- -r\n```\n\n### Sync repo process\n\nIn case needs to fetch the last changes all repository/sub-modules might be used `./scripts/sync-repo.sh` bash script.\nAvailable the following arguments:\n\n```console\n./scripts/sync-repo.sh -h\n\nUsage: ./scripts/sync-repo.sh [options] | [-h]\n\nOptions:\n  -a    Sync all repositories\n  -m    Sync bfx-report-electron only\n  -w    Sync bfx-reports-framework only\n  -u    Sync bfx-report-ui only\n  -e    Sync bfx-report-express only\n  -h    Display help\n```\n\nTo launch `./scripts/sync-repo.sh` script also can be used the following NPM script:\n\n```console\nnpm run sync-repo -- -wue\n```\n\n### Launch Electron App for dev purpose\n\nFor Dev purpose to launch the Electron app locally might be used the following NPM script:\n\n```console\nnpm start\n```\n\nAlso, there's available an option to debug the auto-update flow non-packaged build, in that case, just need to set the corresponding environment variable before running `npm start`:\n\n```console\nexport IS_AUTO_UPDATE_BEING_TESTED=true\n```\n\n### Launch build process\n\nFor doing builds for other platforms please have [Multi Platform Build](https://www.electron.build/multi-platform-build) in consideration\n\nTo launch Docker Compose services to build releases and publish executable artifacts of the electron app available the `./scripts/launch.sh` bash script.\nAvailable the following arguments:\n\n```console\n./scripts/launch.sh -h\n\nUsage: ./scripts/launch.sh [options] [-h]\n\nOptions:\n  -a    Build all releases\n  -l    Build Linux release\n  -w    Build Windows release\n  -m    Build Mac release\n  -r    Sync all repositories\n  -o    Sync only sub-modules\n  -s    Use staging BFX API\n  -d    Set development environment\n  -u    Turn off auto-update\n  -p    Publish artifacts\n  -h    Display help\n```\n\nIt provides the following steps:\n\n- if the corresponding flag is added will be fetched the last changes repository/sub-modules\n- launch Docker container to build UI using `./scripts/build-ui.sh` entrypoint, compiled UI files will be used in the build process of the Electron app\n- launch Docker containers for selected OSs (Linux, Windows, Mac) to build releases of the Electron app using `./scripts/build-release.sh` entrypoint\n- if `-p` flag is passed and `GH_TOKEN` or `GITHUB_TOKEN` environment variable is set:\n  - after the binary artifacts are successfully built\n  - publish artifacts on the github releases page as a `draft`\n  - after which they can be downloaded/tested and if everything is fine, press the buttons for editing and then publishing the release with the corresponding tag, check this [Recommended GitHub Releases Workflow](https://www.electron.build/configuration/publish#recommended-github-releases-workflow)\n- without `-p` flag, artifacts will be in the `./dist` folder\n\nTo launch `./scripts/launch.sh` script also can be used the following NPM script:\n\n```console\nnpm run launch -- -aop\n```\n\n\u003e Also, we provide [GitHub Actioins workflows](https://docs.github.com/en/actions/using-workflows/about-workflows) configs for automated building and publishing of the Electron app artifacts using the above-described scripts `./scripts/launch.sh` and `./scripts/build-release.sh`, see the corresponding file `.github/workflows/build-electron-app.yml`\n\n## Locations of ElectronJS App files on different OSs\n\n- Logs:\n  - Ubuntu: `~/.config/Bitfinex Report/logs`\n  - Windows: `C:\\Users\\$username\\AppData\\Roaming\\Bitfinex Report\\logs`\n  - Mac: ElectronJS logs: `~/Library/Logs/Bitfinex Report` and app logs `~/Library/Application Support/Bitfinex Report/logs`\n- DB files `db-sqlite_sync_m0.db`, `db-sqlite_sync_m0.db-shm` (optional), `db-sqlite_sync_m0.db-wal` (optional):\n  - Ubuntu: `~/.config/Bitfinex Report`\n  - Windows: `C:\\Users\\$username\\AppData\\Roaming\\Bitfinex Report`\n  - Mac: `~/Library/Application Support/Bitfinex Report`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report-electron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfinexcom%2Fbfx-report-electron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-report-electron/lists"}