diff --git a/README.md b/README.md index 4ef84854..ff627e27 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,74 @@ -Hummingbot Dashboard is a community project to build dashboards that help you deploy, manage, backtest, and analyze Hummingbot instances (and much more!) Each dashboard is maintained by 1-2 community members. +# Hummingbot Dashboard -### Dashboards +Hummingbot Dashboard is an open-source application designed to assist in the creation, backtesting, and optimization of a wide variety of algorithmic trading strategies. Once refined, these strategies can be deployed as [Hummingbot](https://github.com/hummingbot/hummingbot) instances in either paper trading or live trading modes, providing a seamless transition from strategy formulation to actual trading execution. -Here are the current dashboards in the collection: +## Features -* 🐙 **Bot Orchestration**: Deploy and manage Hummingbot instances -* ⚙️ **Backtest Manager**: Backtest strategies against historical data and optimize hyper-parameters -* 🚀 **Strategy Performance**: Analyze the performance of a running Hummingbot instance -* 🗂 **Candles Downloader**: Download historical exchange data as OHLVC candles. Supports multiple trading pairs and custom time ranges/intervals. -* 🔍 **DB Inspector**: Inspect and analyze the orders and trades data contained in a Hummingbot strategy database -* 🧙 **Token Spreads**: Identify cross-exchange trading opportunities by analyzing differences in token spreads across venues -* 🦉 **TVL vs MCAPs**: Easily compare various DeFi protocols based on their market capitalization and total value locked, using DeFiLlama data. +- **Bot Orchestration**: Deploy and manage multiple instances of Hummingbot +- **Strategy Backtesting and Optimization**: Evaluate the performance of your strategies against historical data and optimize them with Optuna +- **One-Click Deployment**: Seamlessly deploy your strategies as Hummingbot instances for paper or live trading. +- **Performance Analysis Monitoring**: Monitor and analyze the performance of your deployed strategies. +- **Secure Credentials**: Restrict access to whitelisted users + +## Tutorial -### Installation +Get a comprehensive understanding of Hummingbot Dashboard by exploring our introductory video playlist. These videos will guide you through the various features and functionalities: -This project is built using [StreamLit](https://streamlit.io/) and uses Anaconda and Docker to simplify installation, updates, and manage dependencies. +1. [Introduction to Dashboard](https://www.youtube.com/watch?v=a-kenMqRB00&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=1) +2. [Setting up the Environment](https://www.youtube.com/watch?v=AbezIhb6iJg&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=2) +3. [Managing Credentials](https://www.youtube.com/watch?v=VmlD_WQVe4M&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=3) +4. [Using the Master Bot Profile](https://www.youtube.com/watch?v=MPQTnlDXPno&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=4) +5. [Deploying Bots and Running Strategies](https://www.youtube.com/watch?v=915E-C2LWdg&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=5) +6. Analyzing Strategy Performance (coming soon) +7. [Controllers, Backtesting, and Optimization](https://www.youtube.com/watch?v=bAi2ok7_boo&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=6) +8. [Deploying Best Strategies from Backtests](https://www.youtube.com/watch?v=BJf3ml-9JIQ&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=7) +9. [Conclusions and Next Steps](https://www.youtube.com/watch?v=ug_SSZb2HYE&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=8) -See [Installation](https://github.com/hummingbot/dashboard/blob/main/INSTALLATION.md) for how to install and update the dashboard. +## Documentation -### Contributions and feedback +For detailed instructions and further information, visit our [documentation page](https://hummingbot.org/dashboard/). -We welcome contributions from the community! See [Contributing](https://github.com/hummingbot/dashboard/blob/main/CONTRIBUTING.md) for more information. +## Installation -To provide feedback, submit a [Github issue](https://github.com/hummingbot/dashboard/issues) or join the #dashboard channel in our [Discord](https://discord.gg/hummingbot). +Currently, Dashboard should be installed from source via the process below. In the future, we aim to support a simpler,Docker-based installation process as well. + +1. **Install Dependencies**: + - Docker Engine + - Miniconda or Anaconda + +2. **Clone Repository and Navigate to Directory**: + ```bash + git clone https://github.com/hummingbot/dashboard.git + cd dashboard + ``` + +3. **Create Conda Environment and Install Dependencies**: + ```bash + make env_create + ``` + +4. **Activate the Isolated 'conda' Environment**: + ```bash + conda activate dashboard + ``` + +5. **Start the Dashboard**: + ```bash + streamlit run main.py + ``` + +For more detailed instructions on how to install and update the dashboard, refer to [INSTALLATION.md](INSTALLATION.md). + +## Latest Updates + +Stay informed about the latest updates and enhancements to Hummingbot Dashboard by subscribing to our [newsletter](https://hummingbot.substack.com/). + +## Contributing and Feedback + +We welcome contributions from the community. Please read our [contributing guidelines](CONTRIBUTING.md) to get started. + +Join our [Discord](https://discord.gg/hummingbot) community to discuss strategies, ask questions, and collaborate with other Hummingbot Dashboard users: + +## License + +Hummingbot Dashboard is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for more details.