{"id":22608916,"url":"https://github.com/bitfinexcom/bfx-hf-data-server","last_synced_at":"2025-04-11T06:13:58.608Z","repository":{"id":37795975,"uuid":"143998055","full_name":"bitfinexcom/bfx-hf-data-server","owner":"bitfinexcom","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-11T18:59:43.000Z","size":263,"stargazers_count":13,"open_issues_count":10,"forks_count":22,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-11T06:13:50.589Z","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","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-08-08T10:28:06.000Z","updated_at":"2022-12-19T02:42:20.000Z","dependencies_parsed_at":"2023-10-11T17:20:10.417Z","dependency_job_id":null,"html_url":"https://github.com/bitfinexcom/bfx-hf-data-server","commit_stats":{"total_commits":241,"total_committers":11,"mean_commits":21.90909090909091,"dds":0.5892116182572614,"last_synced_commit":"b896b42bfc86ff6217544aefb7e010f1be0ea6a1"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-hf-data-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-hf-data-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-hf-data-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fbfx-hf-data-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfinexcom","download_url":"https://codeload.github.com/bitfinexcom/bfx-hf-data-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351393,"owners_count":21089270,"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:06.115Z","updated_at":"2025-04-11T06:13:58.573Z","avatar_url":"https://github.com/bitfinexcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Bitfinex Honey Framework Data Server for Node.JS\n\n[![Build Status](https://travis-ci.org/bitfinexcom/bfx-hf-data-server.svg?branch=master)](https://travis-ci.org/bitfinexcom/bfx-hf-data-server)\n\nThe HF data server runs backtests for the HF UI Electron App. It syncs candle and trade data and then executes the strategy on it for backtesting.\n\nThe DB backend is implemented by a plugin:\n* [bfx-hf-models-adapter-lowdb](https://github.com/bitfinexcom/bfx-hf-models-adapter-lowdb)\n\nRegardless of the backend, a schema must be specified (providing exchange-specific API methods). The official Bitfinex schema is [bfx-hf-ext-plugin-bitfinex](https://github.com/bitfinexcom/bfx-hf-ext-plugin-bitfinex).\n\n### Installation\n\nFor standalone usage:\n```bash\ngit clone https://github.com/bitfinexcom/bfx-hf-data-server\ncd bfx-hf-data-server\nnpm i\n\ncp .env.example .env\n\nnpm run start-lowdb\n```\n\nFor usage/extension within an existing project:\n```bash\nnpm i --save bfx-hf-data-server\n```\n\n### Quickstart\n\nFollow the installation instructions, and run `npm run start-lowdb`.\n\n### Docs\n\nFor executable examples, [refer to `examples/`](/examples)\n\n### Example\n\n```js\nconst DataServer = require('bfx-hf-data-server')\nconst HFDB = require('bfx-hf-models')\nconst HFDBLowDBAdapter = require('bfx-hf-models-adapter-lowdb')\nconst { schema: HFDBBitfinexSchema } = require('bfx-hf-ext-plugin-bitfinex')\n\nconst db = new HFDB({\n  schema: HFDBBitfinexSchema,\n  adapter: HFDBLowDBAdapter({\n    dbPath: './SOME_DB_PATH.json',\n    schema: HFDBBitfinexSchema\n  })\n})\n\nconst ds = new DataServer({\n  port: 8899,\n  db\n})\n\nds.open()\n\n// data server ready to receive commands\n```\n\n### Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n### Note\n\nThis package will be maintained only via github, please use latest relases from github instead of npm.\n\nExample on how to install specific version from github:\n```\nnpm i --save-prod https://github.com/bitfinexcom/bfx-hf-data-server.git#v3.0.4\n```\n\nExample on how to install it latest version from github:\n```\nnpm i --save-prod https://github.com/bitfinexcom/bfx-hf-data-server.git\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-hf-data-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfinexcom%2Fbfx-hf-data-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fbfx-hf-data-server/lists"}