Skip to content

Commit 9ac50f2

Browse files
committed
docs: add screenshots to readme
1 parent 7595664 commit 9ac50f2

4 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ A self-hosted database management platform. Spin up PostgreSQL, MySQL, MariaDB,
1111
![Frontend](https://img.shields.io/badge/frontend-React-blue.svg)
1212
![Backend](https://img.shields.io/badge/backend-Go-blue.svg)
1313

14+
## Table of Contents
15+
16+
- [Overview](#overview)
17+
- [Quick Start](#quick-start)
18+
- [Features](#features)
19+
- [CLI Options](#cli-options)
20+
- [Docker Compose](#docker-compose)
21+
- [Development](#development)
22+
- [Requirements](#requirements)
23+
- [Screenshots](#screenshots)
24+
- [License](#license)
1425
## Overview
1526
DBnest is a lightweight, self-hosted database management platform that allows developers and teams to quickly provision, manage, and monitor multiple database instances through a unified web interface. It uses containerization technologies like Docker to isolate each database instance, making it easy to create, delete, and manage databases without complex setups.
1627

@@ -90,5 +101,27 @@ task run
90101

91102
- Docker/Podman/containerd
92103

104+
## Screenshots
105+
106+
<details>
107+
<summary>Click to view screenshots</summary>
108+
109+
<p align="center">
110+
<img src="docs/screenshots/main.png" alt="Dashboard" width="800">
111+
<br><em>Dashboard - Manage all your database instances</em>
112+
</p>
113+
114+
<p align="center">
115+
<img src="docs/screenshots/details.png" alt="Database Details" width="800">
116+
<br><em>Database Details - Metrics, logs, and connection info</em>
117+
</p>
118+
119+
<p align="center">
120+
<img src="docs/screenshots/topology.png" alt="Network Topology" width="800">
121+
<br><em>Network Topology - Visualize your database network</em>
122+
</p>
123+
124+
</details>
125+
93126
## License
94127
MIT

docs/screenshots/details.png

237 KB
Loading

docs/screenshots/main.png

356 KB
Loading

docs/screenshots/topology.png

215 KB
Loading

0 commit comments

Comments
 (0)