Skip to content

Commit e0bde1b

Browse files
committed
Add example screenshots and update EXAMPLES.md with ServerHub showcase
1 parent 15af426 commit e0bde1b

17 files changed

Lines changed: 96 additions & 1 deletion

docs/EXAMPLES.md

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,48 @@ dotnet run --project Examples/<ExampleName>
1111

1212
---
1313

14+
## 🏆 Real-World Applications
15+
16+
### ServerHub
17+
Production-ready Linux server control panel built with SharpConsoleUI.
18+
19+
![ServerHub Dashboard](images/examples/serverhub-main.png)
20+
21+
**Project:** [github.com/nickprotop/ServerHub](https://github.com/nickprotop/ServerHub)
22+
23+
**Description:** Terminal-based control panel for Linux servers and homelabs with 14 bundled widgets for monitoring CPU, memory, disk, network, Docker containers, systemd services, and more.
24+
25+
**Key Features:**
26+
- Real-time system monitoring dashboard
27+
- Widget-based architecture with 14 built-in widgets
28+
- Network traffic visualization with historical trends
29+
- Widget browser with search and filtering
30+
- Custom widget support (any language)
31+
- Context-aware actions system
32+
33+
**Screenshots:**
34+
35+
| Main Dashboard | Network Traffic | Widget Browser |
36+
|----------------|-----------------|----------------|
37+
| ![Main](images/examples/serverhub-main.png) | ![Network](images/examples/serverhub-network.png) | ![Widgets](images/examples/serverhub-widgets.png) |
38+
39+
**What it demonstrates:**
40+
- SharpConsoleUI powering a production application
41+
- Complex multi-widget dashboard layouts
42+
- Real-time data visualization with sparklines
43+
- Professional UI/UX in a TUI environment
44+
45+
---
46+
1447
## Examples by Category
1548

1649
### 🎮 Interactive Applications
1750

1851
#### SnakeGame
1952
Classic Snake game demonstrating direct frame buffer manipulation.
2053

54+
![Snake Game](images/examples/snakegame.png)
55+
2156
```bash
2257
dotnet run --project Examples/SnakeGame
2358
```
@@ -36,6 +71,8 @@ dotnet run --project Examples/SnakeGame
3671
#### AgentStudio
3772
OpenCode-inspired TUI showcase demonstrating an AI coding agent interface aesthetic.
3873

74+
![AgentStudio](images/examples/agentstudio.png)
75+
3976
```bash
4077
dotnet run --project Examples/AgentStudio
4178
```
@@ -53,6 +90,14 @@ dotnet run --project Examples/AgentStudio
5390
#### ConsoleTopExample
5491
ntop/btop-inspired live system monitoring dashboard.
5592

93+
| Processes | Memory | CPU |
94+
|-----------|--------|-----|
95+
| ![Processes](images/examples/consoletop-processes.png) | ![Memory](images/examples/consoletop-memory.png) | ![CPU](images/examples/consoletop-cpu.png) |
96+
97+
| Network | Storage |
98+
|---------|---------|
99+
| ![Network](images/examples/consoletop-network.png) | ![Storage](images/examples/consoletop-storage.png) |
100+
56101
```bash
57102
dotnet run --project Examples/ConsoleTopExample
58103
```
@@ -72,6 +117,8 @@ dotnet run --project Examples/ConsoleTopExample
72117
#### MultiDashboard
73118
Showcases multiple windows with independent async update threads.
74119

120+
![MultiDashboard](images/examples/multidashboard.png)
121+
75122
```bash
76123
dotnet run --project Examples/MultiDashboard
77124
```
@@ -89,6 +136,8 @@ dotnet run --project Examples/MultiDashboard
89136
#### HighFreqDemo
90137
Multi-frequency update showcase with various control update rates.
91138

139+
![HighFreqDemo](images/examples/highfreqdemo.png)
140+
92141
```bash
93142
dotnet run --project Examples/HighFreqDemo
94143
```
@@ -108,6 +157,8 @@ dotnet run --project Examples/HighFreqDemo
108157
#### CompositorEffectsExample
109158
Demonstrates compositor-style buffer manipulation capabilities.
110159

160+
![Compositor Effects](images/examples/compositor-fractal.png)
161+
111162
```bash
112163
dotnet run --project Examples/CompositorEffectsExample
113164
```
@@ -143,6 +194,26 @@ dotnet run --project Examples/FrameRateDemo
143194

144195
---
145196

197+
#### FigletShowcaseExample
198+
ASCII art font showcase demonstrating Figlet font rendering.
199+
200+
![Figlet Showcase](images/examples/figletshowcase.png)
201+
202+
```bash
203+
dotnet run --project Examples/FigleShowcaseExample
204+
```
205+
206+
**Key Features:**
207+
- Multiple Figlet ASCII art fonts (Star Wars, Graffiti, etc.)
208+
- Font size comparison demo
209+
- Color cycling with animated background
210+
- Direct font loading from FLF (FigletFont) files
211+
- Text alignment and positioning options
212+
213+
**Controls:** Number keys to switch examples, Esc to close
214+
215+
---
216+
146217
### 🖱️ Controls & Interactions
147218

148219
#### DemoApp
@@ -169,6 +240,8 @@ dotnet run --project Examples/DemoApp
169240
#### MenuDemo
170241
Full-featured horizontal menu bar with keyboard and mouse support.
171242

243+
![MenuDemo](images/examples/menudemo.png)
244+
172245
```bash
173246
dotnet run --project Examples/MenuDemo
174247
```
@@ -247,6 +320,26 @@ dotnet run --project Examples/SpectreMouseExample
247320

248321
---
249322

323+
#### TextEditorExample
324+
Multiline text editor with syntax highlighting and file browser.
325+
326+
![Text Editor](images/examples/texteditor.png)
327+
328+
```bash
329+
dotnet run --project Examples/TextEditorExample
330+
```
331+
332+
**Key Features:**
333+
- Multiline edit control with scrolling
334+
- File browser dialog integration
335+
- Syntax highlighting support
336+
- Save/load functionality
337+
- Line numbers and cursor position
338+
339+
**Controls:** Ctrl+O to open file, Ctrl+S to save, arrow keys to navigate
340+
341+
---
342+
250343
### 🪟 Window Features
251344

252345
#### FullScreenExample
@@ -321,6 +414,8 @@ dotnet run --project Examples/PluginShowcaseExample
321414
| PanelDemo | | || | | |
322415
| SnakeGame | || | | ||
323416
| CompositorEffectsExample ||| || | |
417+
| TextEditorExample | | | | | | |
418+
| FigletShowcaseExample | | | | | | |
324419

325420
---
326421

@@ -340,7 +435,7 @@ dotnet run --project Examples/PluginShowcaseExample
340435
| `BarGraphControl` | HighFreqDemo |
341436
| `ProgressBarControl` | DemoApp |
342437
| `PromptControl` | DemoApp (Command Window) |
343-
| `MultilineEditControl` | DemoApp |
438+
| `MultilineEditControl` | DemoApp, TextEditorExample |
344439
| `LogViewerControl` | DemoApp |
345440
| `HorizontalGridControl` | Most examples |
346441
| `SpectreRenderableControl` | SpectreMouseExample |
466 KB
Loading
351 KB
Loading
426 KB
Loading
391 KB
Loading
470 KB
Loading
638 KB
Loading
473 KB
Loading
428 KB
Loading
511 KB
Loading

0 commit comments

Comments
 (0)