Abhishek commited on
Commit
375e6ae
ยท
1 Parent(s): 757031e

๐Ÿ›  Add Hugging Face metadata config to README

Browse files
Files changed (1) hide show
  1. README.md +10 -109
README.md CHANGED
@@ -1,113 +1,14 @@
1
- # ๐Ÿ“Š Binance Crypto Market Dashboard
2
-
3
- This project is a real-time cryptocurrency market tracker built using **Streamlit**, powered by **Binance's public API**. It displays the **top 10 traded coins** based on 24-hour volume and includes smart insights like **investment suggestions**, **market movement predictions**, and **trend charts** that update every 10 seconds.
4
-
5
- ---
6
-
7
- ## ๐Ÿš€ Live Demo
8
-
9
- โš ๏ธ **IMPORTANT**: Due to **Binance's legal restrictions and regional API blocks**, this app may **not work correctly on Streamlit Cloud** (you may see a `451` error).
10
- โœ… It works perfectly when run **locally** on your own machine. See instructions below.
11
-
12
- ---
13
-
14
- ## ๐Ÿง  Features
15
-
16
- - โœ… **Top 10 Coins by 24h Volume**
17
- - ๐Ÿ”„ **Auto-refresh every 10 seconds**
18
- - ๐Ÿ”บ **Price Change with Emoji Indicators**
19
- - ๐Ÿ’ก **Market Suggestions** (Trending Up / Avoid / Neutral)
20
- - ๐Ÿ”ฎ **Prediction Labels** (Likely โ†‘ / โ†“ / Uncertain)
21
- - ๐Ÿ“ˆ **Trendline Charts** (Last 5 minutes of activity)
22
- - ๐Ÿ’ต **Currency Conversion Support**
23
- - Supports USD, INR, EUR, GBP, JPY
24
- - Uses live exchange rates via `exchangerate.host`
25
- - Falls back to manual rates if the API fails
26
- - ๐Ÿงญ **Sidebar Controls**:
27
- - Toggle Market Tips
28
- - Toggle Drop Alerts
29
- - Select preferred currency
30
- - ๐Ÿง  Optimized with `@st.cache_data` for smooth refresh
31
- - ๐ŸŒ Fully interactive via Streamlit UI
32
-
33
- ---
34
-
35
- ## ๐Ÿ“ฆ Tech Stack
36
-
37
- | Tool | Purpose |
38
- |--------------------|------------------------------------|
39
- | `Streamlit` | Web UI + real-time interactivity |
40
- | `Binance API` | Live crypto market data |
41
- | `exchangerate.host`| Live USD-to-currency conversion |
42
- | `Pandas` | Data processing and transformation |
43
- | `Matplotlib` | Price trend visualization |
44
- | `Requests` | REST API access |
45
-
46
- ---
47
-
48
- ## โš™๏ธ How to Run Locally
49
-
50
- If the online version fails (due to Binance API block), run the app locally:
51
-
52
- 1. **Clone the repository**
53
- ```bash
54
- git clone https://github.com/abhishekmohank/binance_dashboard.git
55
- cd binance_dashboard
56
- ```
57
-
58
- 2. **Install the required packages**
59
- ```bash
60
- pip install -r requirements.txt
61
- ```
62
-
63
- 3. **Start the app**
64
- ```bash
65
- streamlit run app.py
66
- ```
67
-
68
- ---
69
-
70
- ## ๐Ÿ›‘ Known Issues
71
-
72
- > Binance may **block Streamlit Cloud or other hosts** in certain regions, resulting in:
73
- > ```
74
- > 451 Client Error: Unavailable For Legal Reasons
75
- > ```
76
- > โœ… This app works fine on:
77
- > - Your **local machine**
78
- > - Platforms like **Render**, **Replit**, or **a personal VPS**
79
-
80
  ---
81
-
82
- ## โœ… Updates & Enhancements
83
-
84
- - โœ… Market tip system showing top trending coins
85
- - โœ… Drop alert system warning against falling assets
86
- - โœ… Live currency conversion with USD, INR, EUR, GBP, JPY
87
- - โœ… Fallback to manual conversion if API fails
88
- - โœ… Smart emoji-based prediction and suggestions
89
- - โœ… Live trend charting using Matplotlib
90
- - โœ… Sidebar toggles and currency selector
91
-
92
  ---
93
 
94
- ## ๐Ÿงช Future Enhancements (Optional Ideas)
95
-
96
- - ๐Ÿ“ค Export table to CSV or JSON
97
- - ๐Ÿ“ฑ Make layout responsive on mobile
98
- - ๐Ÿ”” Add custom alerts (e.g., if price > X)
99
- - ๐Ÿง  Basic ML for short-term trend prediction
100
-
101
- ---
102
-
103
- ## ๐Ÿ™‹โ€โ™‚๏ธ About the Author
104
-
105
- Made with โค๏ธ by **Abhishek Mohan**
106
- ๐Ÿ”— [GitHub](https://github.com/abhishekmohank)
107
- ๐ŸŒ [Portfolio](https://abhishek-amk.vercel.app)
108
-
109
- ---
110
-
111
- ## ๐Ÿ“œ License
112
 
113
- MIT License โ€” free to use, modify, and share.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Binance Crypto Dashboard
3
+ emoji: ๐Ÿ“Š
4
+ colorFrom: gray
5
+ colorTo: blue
6
+ sdk: streamlit
7
+ sdk_version: "1.30.0"
8
+ app_file: app.py
9
+ pinned: false
 
 
 
10
  ---
11
 
12
+ # ๐Ÿ“Š Binance Crypto Market Dashboard
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
 
14
+ This is a live cryptocurrency dashboard built with Streamlit that tracks the top 10 coins on Binance. It includes smart suggestions, auto-refresh, live currency conversion, and real-time charts.