This project visualises order flow of XBT/USD and ETH/USD in real time.
- Install dependencies:
$ yarn - Install eslint and use the local config:
.eslintrc.json - Install prettier and use the local config:
.prettierrc.json - Run the project locally:
$ yarn start
order flow socket ----> order flow worker ----> order flow service
This app uses a worker as a proxy to connect to the websocket API. This is done to offload some heavy array processing and fast incoming websocket messages away from the UI thread.
Before contributing please ensure you have ESLint and Prettier set up and pointing to the configs in the root of this project.
Unit tests are run with Jest and React Testing Library.
To run tests: $ yarn test
Working branch: develop
Production branch: master
Branches should follow the below format:
<type>/<brief-description> E.g. feat/add-new-coin-pair or fix/bar-chart-bug
Commits should follow Angular commit format:
<type>(<scope>): <subject> E.g. feat(Index): add new context provider or docs(readme): specify angular commit format
Deployments are handled via Netlify. A new build is deployed when updates are pushed to master.