|
| 1 | +# 🖥️ System Health Dashboard |
| 2 | + |
| 3 | +A lightweight Flask-based dashboard to monitor your system's real-time health — including **CPU**, **RAM**, **Disk usage**, and **system time** — all containerized with **Docker** and powered by **GitHub Actions CI**. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 🚀 Features |
| 8 | + |
| 9 | +- 📊 Real-time system status (CPU, RAM, Disk) |
| 10 | +- 🐍 Backend: Python + Flask + psutil |
| 11 | +- 🌐 Simple HTML frontend |
| 12 | +- 🐳 Docker & docker-compose ready |
| 13 | +- ✅ GitHub Actions CI integrated |
| 14 | + |
| 15 | +--- |
| 16 | + |
| 17 | +## 📦 Tech Stack |
| 18 | + |
| 19 | +| Layer | Technology | |
| 20 | +|-----------|------------------------| |
| 21 | +| Backend | Python, Flask, psutil | |
| 22 | +| Frontend | HTML | |
| 23 | +| Container | Docker, docker-compose | |
| 24 | +| CI/CD | GitHub Actions | |
| 25 | + |
| 26 | +--- |
| 27 | + |
| 28 | +## 📸 Screenshot |
| 29 | + |
| 30 | +> *(Add a screenshot here once UI is complete)* |
| 31 | +
|
| 32 | +--- |
| 33 | + |
| 34 | +## ⚙️ How to Run Locally |
| 35 | + |
| 36 | +### 🔧 Using Docker (Recommended) |
| 37 | + |
| 38 | +```bash |
| 39 | +docker-compose up |
| 40 | +``` |
| 41 | + |
| 42 | +- **Backend:** [http://localhost:5000/health](http://localhost:5000/health) |
| 43 | +- **Frontend:** Open the file `index.html` in your browser (located at `backend/frontend/index.html`) |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 🧪 Health Endpoint Sample Output |
| 48 | + |
| 49 | +```json |
| 50 | +{ |
| 51 | + "cpu": "13%", |
| 52 | + "ram": "47%", |
| 53 | + "disk": "62%", |
| 54 | + "time": "2025-05-29 15:44:01" |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## 🛠 GitHub Actions CI |
| 61 | + |
| 62 | +- Auto-runs on push to the `main` branch |
| 63 | +- Verifies the `/health` endpoint is working using `curl` |
| 64 | +- Ensures backend boots and responds properly |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## 🔜 Next Steps |
| 69 | + |
| 70 | +- Add live charts with Chart.js |
| 71 | +- Deploy the project on platforms like Render or Railway |
| 72 | +- Improve the UI and add auto-refresh functionality |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 🧑💻 Author |
| 77 | + |
| 78 | +**Syntax-Vibe-Amir** |
| 79 | +🔗 GitHub: [github.com/Syntax-Vibe](https://github.com/Syntax-Vibe) |
0 commit comments