Skip to content

Enhance README with project flowchart #24

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.

Sign up for GitHub

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

Open
granjacours697-netizen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance README with project flowchart #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 35 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,39 @@ To execute/build locally:


This project is maintained by [hanniabu.eth](https://twitter.com/hanni_abu).
graph TB
subgraph Data["Data Collection & Storage"]
A[Ethereum Network] -->|Query Validator State| B[Data Collector]
B -->|Process & Transform| C[historical_data.json]
C -->|Store Historical Records| D[(JSON Database)]
end

subgraph Automation["Automated Workflows"]
E[GitHub Actions Scheduler] -->|Trigger Updates| F[Update Job]
F -->|Fetch Latest Data| B
F -->|Commit Changes| G[Git Repository]
end

subgraph UI["Web Frontend"]
H[index.html] -->|Display| I[Validator Queue Dashboard]
J[CSS Styles] --> I
K[JavaScript Logic] --> I
C -->|Feed Data| I
end

subgraph Metrics["Key Metrics Tracked"]
L["🔢 Validator Count"]
M["📊 Entry Queue Size"]
N["⏱️ Wait Times"]
O["📈 Churn Rates"]
P["💰 Staked Amount"]
end

D -.->|Historical Analysis| I
I -.->|Display| Metrics

style Data fill:#e1f5ff
style Automation fill:#fff3e0
style UI fill:#f3e5f5
style Metrics fill:#e8f5e9