Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Readme #42

Merged
merged 1 commit into from
Jul 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 45 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
# Hummingbot Dashboard

Collection of Hummingbot-related dashboards, built using [StreamLit](https://streamlit.io/).
Collection of data visualization and analysis Hummingbot-related dashboards. The dashboards helps you run and manage Hummingbot, analyze performance, analyze trade data, and much more!

Dashboard is built using [StreamLit](https://streamlit.io/) and uses the Conda environment & package manager to simiplify installation, updates, and manage dependencies.

You will need to install [StreamLit](https://streamlit.io/). For information about Streamlit installation, see the instructions located at https://docs.streamlit.io/library/get-started/installation.

You will also need to install either [Anaconda](https://www.anaconda.com/) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) to get Conda:
* [Anaconda](https://www.anaconda.com/) is a comprehensive Python distribution that includes a large number of pre-installed data science libraries and packages. It is designed to be an all-in-one solution for data science and machine learning tasks. When you install Anaconda, it comes with a collection of popular Python packages like NumPy, pandas, matplotlib, scikit-learn, and more.
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) is a minimal version of Anaconda. It includes only the essential components, such as Python interpreter and Conda package manager. Unlike Anaconda, Miniconda doesn't come with pre-installed packages, which makes its download size much smaller.

This repository is maintained by Hummingbot Foundation as a companion for users of [Hummingbot](https://github.com/hummingbot/hummingbot), the open source framework for building high-frequency crypto trading bots.

Watch this video to understand how it works:
https://www.loom.com/share/72d05bcbaf4048a399e3f9247d756a63

See an example of a live, deployed dashboard:
https://hummingbot-streamlit-app-main-jnja50.streamlit.app


## Dashboards

Expand Down Expand Up @@ -48,20 +55,22 @@ Reference data for the various apps this collection.

## Installation

1. Install [Anaconda](https://www.anaconda.com/) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
1. Install Steamlit and Conda packages utilizing their instructions for your specific environment:
* Install [StreamLit](https://docs.streamlit.io/library/get-started/installation)
* Install [Anaconda](https://docs.anaconda.com/free/anaconda/install/index.html) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html)

2. Clone this repo and navigate to the created directory
```bash
git clone https://github.com/hummingbot/dashboard.git
cd dashboard
```

3. Run this command to create a `conda` environment and install dependencies
3. Run conda command to create an isolated `conda` environment and install dependencies
```
conda env create -f environment_conda.yml
```

4. Activate the environment
4. Activate the isoldated 'conda' environment
```bash
conda activate dashboard
```
Expand All @@ -71,16 +80,25 @@ conda activate dashboard
streamlit run main.py
```

6. Create a symlink to your Hummingbot `/data` directory
## Data Feed

Your `dashboard` environment needs to have access to the database for your Hummingbot environment. This is done by setting up a symbolic link to the 'data' directory of your running Hummingbot instance.

The data directory differs for Docker versus Source installed Hummingbot. Data directory for each is as follows:
* Docker installed: /path/to/hummingbot/hummingbot_files/data
* Source installed: /path/to/hummingbot/data


Create a symlink to your Hummingbot `/data` directory
```bash
# replace `/path/to/hummingbot` with the actual path
ln -s /path/to/hummingbot/data data
# replace `/path/to/hummingbotdata` with the actual path
ln -s /path/to/hummingbotdata data

# if you need to remove the symlink
unlink data
```

For more info about Streamlit installation, see the instructions located at https://docs.streamlit.io/library/get-started/installation.


## Updates

Expand All @@ -89,8 +107,23 @@ To update the `dashboard` environment for new dependencies, run:
conda env update -f environment_conda.yml
```

To updated the `dashboard` source for latest version, run:
```
cd dashboard
git pull
```

## Contributions

We welcome new data apps, bug fixes, and improvements by the community!
We welcome new data dashboards, bug fixes, and improvements by the community!

To submit a contribution, fork a clone of repository, add or make changes, and issue a pull request. See general guidelines for contributing to Hummingbot listed at https://hummingbot.org/developers/contributions.


## Participation

We hold bi-weekly livestream Dashboard project meetings. You can participate on our [Discord](https://discord.gg/hummingbot)
* Alternating Thursdays, 3pm GMT / 11am EST / 8am PST / 11pm SIN
* Design, Status, Demos, etc


To submit a contribution, issue a pull request, following the guidelines listed at https://hummingbot.org/developers/contributions.