diff --git a/README.md b/README.md new file mode 100644 index 000000000..83cb3f45d --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +
+ +

DBX

+

Open-source, lightweight, cross-platform database management tool.

+

+ + + + + + + + +

+

+ English | 简体中文 +

+
+ +## Features + +- **8 databases** — MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server +- **Schema browser** — Databases, schemas, tables, columns, indexes, foreign keys, triggers +- **Query editor** — CodeMirror with syntax highlighting, auto-complete, Cmd+Enter execution +- **Data grid** — Virtual-scrolled table with inline editing, sorting, pagination, column resize +- **Export** — CSV, JSON, Markdown +- **Redis browser** — Key pattern search, value viewer for all data types +- **MongoDB browser** — Document CRUD with pagination +- **Query history** — Persistent history with search, restore, and one-click copy +- **Safety** — Confirmation dialog for DROP / DELETE / TRUNCATE / ALTER +- **Auto-reconnect** — Transparent retry on connection loss +- **SSH tunnel** — Connect through SSH port forwarding +- **Dark mode** — System-aware theme toggle +- **i18n** — English & 简体中文 +- **Tiny** — ~7 MB installer (no bundled Chromium) + +## Screenshot + +
+ +
+ +## Getting Started + +### Prerequisites + +- [Node.js](https://nodejs.org/) >= 18 +- [pnpm](https://pnpm.io/) +- [Rust](https://www.rust-lang.org/tools/install) >= 1.77 + +### Development + +```bash +pnpm install +pnpm tauri dev +``` + +### Build + +```bash +pnpm tauri build +``` + +The installer will be in `src-tauri/target/release/bundle/`. + +## Tech Stack + +| Layer | Technology | +|-------|-----------| +| Framework | [Tauri 2](https://tauri.app/) | +| Frontend | [Vue 3](https://vuejs.org/) + TypeScript | +| UI | [shadcn-vue](https://www.shadcn-vue.com/) + Tailwind CSS | +| Editor | [CodeMirror 6](https://codemirror.net/) | +| Backend | Rust + [sqlx](https://github.com/launchbadge/sqlx) / [tiberius](https://github.com/prisma/tiberius) / [redis-rs](https://github.com/redis-rs/redis-rs) / [mongodb](https://github.com/mongodb/mongo-rust-driver) | + +## License + +[MIT](LICENSE) diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 000000000..437390e98 --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,78 @@ +
+ +

DBX

+

开源、轻量、跨平台的数据库管理工具。

+

+ + + + + + + + +

+

+ English | 简体中文 +

+
+ +## 功能特性 + +- **8 种数据库** — MySQL、PostgreSQL、SQLite、Redis、MongoDB、DuckDB、ClickHouse、SQL Server +- **结构浏览** — 数据库、Schema、表、字段、索引、外键、触发器 +- **查询编辑器** — CodeMirror 语法高亮、自动补全、Cmd+Enter 执行 +- **数据表格** — 虚拟滚动、行内编辑、排序、分页、列宽调整 +- **数据导出** — CSV、JSON、Markdown +- **Redis 浏览器** — 模式匹配搜索，支持全部数据类型查看 +- **MongoDB 浏览器** — 文档增删改查、分页浏览 +- **查询历史** — 持久化存储，支持搜索、恢复、一键复制 +- **安全防护** — 执行 DROP / DELETE / TRUNCATE / ALTER 时弹出确认对话框 +- **自动重连** — 连接断开后透明重试 +- **SSH 隧道** — 通过 SSH 端口转发连接数据库 +- **深色模式** — 明暗主题一键切换 +- **多语言** — English & 简体中文 +- **极致轻量** — 安装包仅 ~7 MB（不内嵌 Chromium） + +## 截图 + +
+ +
+ +## 快速开始 + +### 环境要求 + +- [Node.js](https://nodejs.org/) >= 18 +- [pnpm](https://pnpm.io/) +- [Rust](https://www.rust-lang.org/tools/install) >= 1.77 + +### 开发 + +```bash +pnpm install +pnpm tauri dev +``` + +### 构建 + +```bash +pnpm tauri build +``` + +安装包输出在 `src-tauri/target/release/bundle/` 目录。 + +## 技术栈 + +| 层级 | 技术 | +|------|------| +| 框架 | [Tauri 2](https://tauri.app/) | +| 前端 | [Vue 3](https://vuejs.org/) + TypeScript | +| UI | [shadcn-vue](https://www.shadcn-vue.com/) + Tailwind CSS | +| 编辑器 | [CodeMirror 6](https://codemirror.net/) | +| 后端 | Rust + [sqlx](https://github.com/launchbadge/sqlx) / [tiberius](https://github.com/prisma/tiberius) / [redis-rs](https://github.com/redis-rs/redis-rs) / [mongodb](https://github.com/mongodb/mongo-rust-driver) | + +## 开源协议 + +[MIT](LICENSE) diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 000000000..43c44d690 Binary files /dev/null and b/docs/screenshot.png differ