workbench - GitLite

KO | EN

gitlite — search

#python #go #golang #machine-learning #rust #macos #java #windows #awesome #cli #vue #ios #mcp #openai

workbench

(★ 122)

From Idea to Execution - Manage your trading operation across a distributed cluster

File Explorer

Download Latest Version (.zip)

- - codeql-analysis.yml
  - test.yml
- dependabot.yml
- - .gitkeep
  - notified_phoenix.d.ts
  - topbar.d.ts
- - app.css
- - app.ts
  - createStore.ts
  - hooks.tsx
  - socket.ts
- - favicon.ico
  - robots.txt
- .eslintrc
- .prettierrc
- babel.config.js
- package-lock.json
- package.json
- postcss.config.js
- tailwind.config.js
- tsconfig.json
- webpack.config.js
- config.exs
- runtime.exs
- CONFIGURATION.md
- FEATURES.md
- grafana-dashboard-balances.png
- grafana-dashboard-beam-vm-health.png
- grafana-dashboard-tai-health.png
- live-balance-snapshots.mov
- live-balance-snapshots.png
- metrics.png
- notifications.png
- OBSERVABILITY.md
- products-index.png
- products-show.png
- prometheus-metrics.png
- remote-control-trade.png
- REQUIREMENTS.md
- stream-realtime-orders.png
- wallets.png
- config.monitoring
- - accounts.ex
  - application.ex
  - asset_aliases.ex
  - balance.ex
  - config.ex
  - db.ex
  - nodes.ex
  - notifications.ex
  - repo.ex
  - schoolbus.ex
  - selected_node.ex
  - wallet.ex
  - wallets.ex
- - decimal.ex
  - endpoint.ex
  - gettext.ex
  - redirector.ex
  - router.ex
  - telemetry.ex
  - time.ex
- workbench.ex
- workbench_web.ex
- - errors.pot
- - seeds.exs
- alerts.yml
- prometheus.yml
- - smoke_test.exs
- - channel_case.ex
  - conn_case.ex
  - data_case.ex
  - file_helpers.ex
  - quotes.ex
- - asset_aliases_test.exs
  - selected_node_test.exs
- - redirector_test.exs
- test_helper.exs
- workbench_test.exs
- tai_monorepo
.env.example
.formatter.exs
.gitattributes
.gitignore
.gitmodules
.iex.exs
docker-compose.override.yml
docker-compose.yml
Dockerfile
LICENSE
mix.exs
mix.lock
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Workbench - From Idea to Execution
[![Build Status](https://github.com/fremantle-industries/workbench/workflows/test/badge.svg?branch=main)](https://github.com/fremantle-industries/workbench/actions?query=workflow%3Atest)
[![hex.pm version](https://img.shields.io/hexpm/v/workbench.svg?style=flat)](https://hex.pm/packages/workbench)

Manage your trading operation across a distributed cluster

[Install](#install) | [Usage](#usage) | [Features](./docs/FEATURES.md) | [Requirements](./docs/REQUIREMENTS.md) | [Configuration](./docs/CONFIGURATION.md) | [Observability](./docs/OBSERVABILITY.md)

## Project Goals

`workbench` strives to provide a first class development environment that brings the same 
productivity and performance benefits from the [Phoenix](https://www.phoenixframework.org/) 
& [Elixir](https://elixir-lang.org/) community to real time algorithmic and quant workflows.

## Install

Add `workbench` to your list of dependencies in `mix.exs`

```elixir
def deps do
  [
    {:workbench, "~> 0.0.18"}
  ]
end
```

Generate migrations

```bash
$ mix workbench.gen.migration
```

Run migrations

```bash
$ mix ecto.migrate
```

## Features

### Stream Real Time Orders

![stream-real-time-orders](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/stream-realtime-orders.png)

### Remotely Control Trade Instances in a Cluster

![remote-control-trade](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/remote-control-trade.png)

### Live Portfolio Tracking & Historical Snapshots

[![live-balance-snapshots](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/live-balance-snapshots.png)](https://youtu.be/cklMhS0KD88)

### Track Cold Storage

![wallets](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/wallets.png)

### Explore Products within the Trading Universe

![products-index](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/products-index.png)
![products-show](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/products-show.png)

### Receive Notifications

[![notifications](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/notifications.png)](https://youtu.be/NJS0YTsKoiQ)

### Monitor Operations Across Your Cluster

![dashboard-beam-vm-health](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/grafana-dashboard-beam-vm-health.png)

![dashboard-tai-health](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/grafana-dashboard-tai-health.png)

![dashboard-balances](https://raw.githubusercontent.com/fremantle-industries/workbench/main/docs/grafana-dashboard-balances.png)

## Usage

### Running workbench as a standalone endpoint

Add the workbench phoenix endpoint to your config

```elixir
config :workbench, WorkbenchWeb.Endpoint,
  http: [port: 4000],
  url: [host: "workbench.localhost", port: "4000"],
```

### Embedding workbench in your own Elixir project

There are two options for running `workbench` along side your existing Elixir projects

1. Plug & Phoenix provide the ability to host multiple endpoints
as servers on different ports

```elixir
# config/config.exs
# Phoenix endpoints
config :my_app, MyAppWeb.Endpoint,
  pubsub_server: MyApp.PubSub,
  http: [port: 4000],
  url: [host: "my-app.localhost", port: "4000"],
  live_view: [signing_salt: "aolmUusQ6//zaa5GZHu7DG2V3YAgOoP/"],
  secret_key_base: "vKt36v4Gi2Orw8b8iBRg6ZFdzXKLvcRYkk1AaMLYX0+ry7k5XaJXd/LY/itmoxPP",
  server: true

config :workbench, WorkbenchWeb.Endpoint,
  pubsub_server: Tai.PubSub,
  http: [port: 4001],
  url: [host: "workbench.localhost", port: "4001"],
  live_view: [signing_salt: "aolmUusQ6//zaa5GZHu7DG2V3YAgOoP/"],
  secret_key_base: "xKt36v4Gi2Orw8b8iBRg6ZFdzXKLvcRYkk1AaMLYX0+ry7k5XaJXd/LY/itmoxPP",
  server: true
```

2. Use a proxy to host multiple endpoints on the same port [https://github.com/jesseshieh/master_proxy](https://github.com/jesseshieh/master_proxy)

```elixir
# mix.exs
def deps do
  [{:master_proxy, "~> 0.1"}]
end
```

```elixir
# config/config.exs
# Phoenix endpoints
config :niex, MyAppWeb.Endpoint,
  pubsub_server: Tai.PubSub,
  live_view: [signing_salt: "aolmUusQ6//zaa5GZHu7DG2V3YAgOoP/"],
  secret_key_base: "vKt36v4Gi2Orw8b8iBRg6ZFdzXKLvcRYkk1AaMLYX0+ry7k5XaJXd/LY/itmoxPP",
  server: false,
  debug_errors: true,
  check_origin: false

config :workbench, WorkbenchWeb.Endpoint,
  pubsub_server: Tai.PubSub,
  live_view: [signing_salt: "polmUusQ6//zaa5GZHu7DG2V3YAgOoP/"],
  secret_key_base: "xKt36v4Gi2Orw8b8iBRg6ZFdzXKLvcRYkk1AaMLYX0+ry7k5XaJXd/LY/itmoxPP",
  server: false,
  debug_errors: true,
  check_origin: false

# Master Proxy
config :master_proxy,
  # any Cowboy options are allowed
  http: [:inet6, port: 4000],
  # https: [:inet6, port: 4443],
  backends: [
    %{
      host: ~r/my-app.localhost/,
      phoenix_endpoint: MyAppWeb.Endpoint
    },
    %{
      host: ~r/workbench.localhost/,
      phoenix_endpoint: WorkbenchWeb.Endpoint
    }
  ]
```

## Development

You can run the app natively on the host

```bash
$ docker-compose up db
$ mix setup
$ mix phx.server
```

Or within `docker-compose`

```
$ docker-compose up
```

Wait a few seconds for the app to boot and you should be able to view the app at `http://workbench.localhost:4000`

## Test

```bash
$ docker-compose up db
$ mix test
```

Save this and re-open workbench in a private tab

## Help Wanted :)

If you think this `workbench` thing might be worthwhile and you don't see a feature 
we would love your contributions to add them! Feel free to drop us an email or open 
a Github issue.

## Authors

* [Alex Kwiatkowski](https://github.com/rupurt) - alex+git@fremantle.io

## License

`workbench` is released under the [MIT license](./LICENSE.md)