# data-workbench-sqlite

**Repository Path**: hefuhai001/data-workbench-sqlite

## Basic Information

- **Project Name**: data-workbench-sqlite
- **Description**: DataWorks 是一个基于 Nuxt 4 打造的自托管 SQLite 管理工具。你可以集中维护多个数据库连接，浏览表结构、读写数据、执行 SQL 查询，并支持导入 / 导出。界面采用清新素雅的深蓝办公风格，已针对手机端与电脑端做了响应式适配。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-24
- **Last Updated**: 2026-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Data Workbench Sqlite

> 专业、高效的 **SQLite 数据管理平台** —— 面向办公场景的深蓝主题现代化界面，支持桌面端与移动端。

Data Workbench Sqlite 是一个基于 **Nuxt 4** 打造的自托管 SQLite 管理工具。你可以集中维护多个数据库连接，浏览表结构、读写数据、执行 SQL 查询，并支持导入 / 导出。界面采用清新素雅的**深蓝办公风格**，已针对手机端与电脑端做了响应式适配。

## 界面预览

<p align="center">
  <img src="public/screenshot-desktop.png" alt="桌面端界面" width="70%" />
</p>
<p align="center">
  <img src="public/screenshot-mobile.png" alt="移动端界面" width="25%" />
</p>

## 功能特性

- **多数据库集中管理**：在「系统配置」中维护若干 SQLite 连接（名称 → 文件绝对路径），侧边栏即时切换。
- **数据表浏览**：列出数据库内的表 / 视图，展示字段数与行数。
- **数据管理**：查看、新增、编辑、删除行；支持文本搜索、列排序、分页。
- **导入 / 导出**：以 JSON 形式批量导入，一键导出全部数据。
- **SQL 查询控制台**：在任意连接上执行查询与写操作，查看执行结果。
- **登录鉴权**：账号密码登录；首次使用自动进入「系统初始化」创建管理员。
- **商业级打磨**：深蓝办公主题、加载 / 空态 / 错误提示、产品化脚注与**赞助支持**。
- **响应式布局**：桌面端侧边栏、移动端抽屉菜单，跨设备体验一致。

## 技术栈

| 领域 | 选型 |
| --- | --- |
| 框架 | Nuxt 4（Nitro 服务端渲染）|
| UI | Vue 3 + Tailwind CSS v4 |
| 数据库驱动 | 内置 `node:sqlite`（Node.js ≥ 22.5）|
| 包管理器 | pnpm（`pnpm-lock.yaml` 已提交）|

---

## 快速开始（本地开发）

环境要求：**Node.js ≥ 22.5**、**pnpm ≥ 10**。

```bash
# 安装依赖（按 lockfile 精确安装）
pnpm install --frozen-lockfile

# 启动开发服务器
pnpm dev
```

访问 http://localhost:3000

> 首次打开会自动进入 `/setup` 初始化管理员账号；之后通过 `/login` 登录，进入工作台 `/`。

### 常用命令

| 命令 | 说明 |
| --- | --- |
| `pnpm dev` | 启动开发服务器（含热更新）|
| `pnpm build` | 构建生产产物 |
| `pnpm preview` | 本地预览生产产物 |
| `pnpm generate` | 生成静态站点 |

---

## 目录结构

```
app/
  assets/css/main.css       # 深蓝主题设计系统（Tailwind v4 @theme）
  layouts/                  # admin（后台）/ default（登录/初始化）
  pages/                    # 工作台、登录、初始化、系统配置、数据库详情、数据管理、SQL
server/
  api/                      # 数据库连接 / 表 / 数据行 / 查询 / 导入导出 相关接口
  utils/                    # 鉴权、配置存储、DDL 解析、数据行读写
config/                     # 数据库连接配置（databases.json，由 WORKBENCH_CONFIG_DIR 指定）
Dockerfile                  # 多阶段生产镜像（pnpm + node:22-alpine）
docker-compose.yml          # 一键部署编排
pnpm-workspace.yaml         # pnpm 配置 + allowBuilds（放行 esbuild 等原生模块构建）
```

---

## Docker 部署

项目提供了多阶段 Dockerfile 与 Compose 编排，构建镜像需 `pnpm`（pnpm 10，corepack 锁定 `pnpm@10.33.0`）。

```bash
docker compose up --build -d
```

- 默认访问地址：`http://localhost:3000`
- 端口可通过环境变量覆盖：`APP_PORT=8080 docker compose up --build -d`
- 连接配置持久化在卷 `workbench_config`（对应容器内 `/app/config`）
- 如需管理宿主已有数据库，把数据目录挂到 `/app/data`，并在「系统配置」填写容器内路径 `/app/data/xxx.db`

> 说明：`pnpm-workspace.yaml` 中的 `allowBuilds` 用于放行 `esbuild`、`rolldown`、`@parcel/watcher` 等原生模块的构建脚本（pnpm 10 默认拦截生命周期脚本）；Dockerfile 会一并复制该配置以正常构建。

---

## 配置说明

连接配置文件默认保存在项目下 `config/databases.json`，可通过环境变量覆盖目录：

```
WORKBENCH_CONFIG_DIR=/path/to/config
```

在「系统配置」页面添加连接时，仅需提供：

- **名称**：用于网址解码与展示（如 `biz1`），对应 `/databases/biz1`
- **文件绝对路径**：指向一个 SQLite 文件（如 `C:/data/biz1.db`）

---

## ☕ 捐赠支持

如果这个项目对你有帮助，请我喝杯奶茶吧～你的支持是我持续维护的动力！

<p align="center">
  <img src="public/donation-qr.jpg" alt="捐赠二维码" width="240" />
</p>

## License

内部项目，仅供学习交流使用。