You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-19Lines changed: 7 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,24 @@
1
1
# Hummingbot Dashboard
2
2
3
-
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.
3
+
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 live trading modes, providing a seamless transition from strategy formulation to actual trading execution.
4
4
5
5
## Features
6
6
7
7
-**Bot Orchestration**: Deploy and manage multiple instances of Hummingbot
8
8
-**Strategy Backtesting and Optimization**: Evaluate the performance of your strategies against historical data and optimize them with Optuna
9
9
-**One-Click Deployment**: Seamlessly deploy your strategies as Hummingbot instances for paper or live trading.
10
10
-**Performance Analysis Monitoring**: Monitor and analyze the performance of your deployed strategies.
11
-
-**Secure Credentials**: Restrict access to whitelisted users
11
+
-**Credential Management**: Create and manage separate accounts for API keys
12
12
13
-
## Tutorial
14
-
15
-
Get a comprehensive understanding of Hummingbot Dashboard by exploring our introductory video playlist. These videos will guide you through the various features and functionalities:
16
-
17
-
1.[Introduction to Dashboard](https://www.youtube.com/watch?v=a-kenMqRB00&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=1)
18
-
2.[Setting up the Environment](https://www.youtube.com/watch?v=AbezIhb6iJg&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=2)
4.[Using the Master Bot Profile](https://www.youtube.com/watch?v=MPQTnlDXPno&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=4)
21
-
5.[Deploying Bots and Running Strategies](https://www.youtube.com/watch?v=915E-C2LWdg&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=5)
22
-
6. Analyzing Strategy Performance (coming soon)
23
-
7.[Controllers, Backtesting, and Optimization](https://www.youtube.com/watch?v=bAi2ok7_boo&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=6)
24
-
8.[Deploying Best Strategies from Backtests](https://www.youtube.com/watch?v=BJf3ml-9JIQ&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=7)
25
-
9.[Conclusions and Next Steps](https://www.youtube.com/watch?v=ug_SSZb2HYE&list=PLDwlNkL_4MMf0Ifvj-HLuQ_Jtf7OV6uzW&index=8)
26
-
27
13
## Documentation
28
14
29
15
For detailed instructions and further information, visit our [documentation page](https://hummingbot.org/dashboard/).
30
16
31
17
## Installation
32
18
33
-
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.
19
+
Currently, we recommend users to install Dashboard using the **[Deploy repo](https://github.com/hummingbot/deploy)** instead as this will automatically launch Dashboard along with the needed components in their own Docker containers.
20
+
21
+
If you are a developer, and want to make changes to the code then we recommend using the Source installation below - please note that you will also need to launch the Backend API and Broker separately (either through source install or through Docker).
34
22
35
23
1.**Install Dependencies**:
36
24
- Docker Engine
@@ -44,7 +32,7 @@ Currently, Dashboard should be installed from source via the process below. In t
44
32
45
33
3. **Create Conda Environment and Install Dependencies**:
46
34
```bash
47
-
make env_create
35
+
make install
48
36
```
49
37
50
38
4. **Activate the Isolated 'conda' Environment**:
@@ -54,7 +42,7 @@ Currently, Dashboard should be installed from source via the process below. In t
54
42
55
43
5. **Start the Dashboard**:
56
44
```bash
57
-
streamlit run main.py
45
+
make run
58
46
```
59
47
60
48
For more detailed instructions on how to install and update the dashboard, refer to [INSTALLATION.md](INSTALLATION.md).
0 commit comments