docs(repo): add directory readmes

This commit is contained in:
t8y2
2026-05-18 02:50:50 +08:00
parent 25b845aee2
commit 00baa3c337
3 changed files with 30 additions and 0 deletions
+9
View File
@@ -0,0 +1,9 @@
# Apps
Runnable DBX applications live here.
## Directories
- `desktop/` - the Vue frontend used by the Tauri desktop app and the Docker/web build.
The Tauri native shell remains in `src-tauri/` because that is the conventional Tauri project location used by the existing build and release tooling.
+10
View File
@@ -0,0 +1,10 @@
# Crates
Rust crates for DBX live here.
## Directories
- `dbx-core/` - shared database core, drivers, schema/query logic, import/export, transfer, and plugin support.
- `dbx-web/` - the Docker/web backend service binary published as `dbx-web`.
The workspace root is defined in the repository-level `Cargo.toml`.
+11
View File
@@ -0,0 +1,11 @@
# Plugins
DBX extension plugins live here.
Plugins are not Node packages, so they intentionally stay separate from `packages/`.
## Directories
- `jdbc/` - optional Java/JDBC plugin for connecting through vendor JDBC drivers and custom JDBC URLs.
Plugin build artifacts, downloaded driver JARs, and local targets are ignored by Git.