Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.01 KB

README.md

File metadata and controls

57 lines (43 loc) · 2.01 KB
Raw

Honey Framework UI

  • Creates HF services as background processes
  • Enables order types (Accum/Dist, MA Crossover, Ping/Pong, Iceberg, TWAP and OCOCO)
  • Define and backtest trading strategies

Installation

git clone https://github.com/bitfinexcom/bfx-hf-ui
cd bfx-hf-ui
npm  install

Create folder to store local db

mkdir ~/.honeyframework
touch ~/.honeyframework/algos.json
touch ~/.honeyframework/hf-bitfinex.json
touch ~/.honeyframework/ui.json

Run in the browser

npm run build
npm run start-server
npm run start-ds-bitfinex
npm start

Build electron app manually

Generates an installable application to run independently from the browser. Once you have ran the below command navigate to the /dist folder and select the instillation executable file for the operating system that you are using.

npm run build
npm run dist-win-unpruned # for windows
npm run dist-mac # for mac
npm run dist-linux # for linux

Install pre-built electron app

Head to the latest cut releases and locate the most recent release. Once there you will see installers attached for linux, mac and windows. Run the installer for the operating system that you are using.

The UI

Starting the HF UI will spawn all of the Honey Framework services that are needed to register custom algo-order definitions in the background. Currently (as of release 1.0.0) the UI will register the built in default order types which will be instantly available for use in the bitfinex.com UI. For more info on how to use algo orders once the UI is running head here.

Alt text

Contributing

  1. Fork it (https://github.com/bitfinexcom/bfx-hf-ui)
  2. Create your feature branch (`git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request