19 lines
1.9 KiB
Markdown
19 lines
1.9 KiB
Markdown
撰寫 README.md（繁體中文）— alterdb 項目願景文件
|
||
===============================================
|
||
|
||
背景：項目目前僅為 `cargo init` 骨架（src/main.rs 為 Hello World，Cargo.toml 無任何依賴），尚無 SQLite 或 Web 相關代碼。因此 README 以「項目願景 + 規劃功能 + 如實標註開發中」的方式撰寫，不虛構已有功能。
|
||
|
||
交付物：新建 /Users/dan/alterminal/alterdb/README.md
|
||
|
||
README 結構：
|
||
1. 標題與一句話簡介 — alterdb：以 SQLite 為底層存儲格式的自定義數據庫引擎，附帶 Web 管理介面
|
||
2. 專案簡介 — 說明定位：不是 SQLite 管理器，而是自定義數據庫引擎（自有查詢層），SQLite 僅作底層存儲；透過本地 Web 伺服器 + 瀏覽器操作管理
|
||
3. 核心特性（規劃中）— 自定義查詢引擎、SQLite 存儲後端、Web 管理介面（資料庫/表瀏覽、執行查詢、數據編輯）、單一可執行檔部署
|
||
4. 架構規劃 — ASCII 分層圖：瀏覽器 Web UI ⇄ HTTP API（Rust 伺服器）⇄ 自定義查詢引擎 ⇄ SQLite 存儲層；技術選型（Rust edition 2024；Web 框架與 SQLite 綁定庫標註為「規劃中、暫定」）
|
||
5. 快速開始 — 環境需求（Rust 1.85+，因使用 edition 2024）、cargo build / cargo run、瀏覽器訪問本地地址；明確標註此為目標使用方式，功能尚未實作
|
||
6. 開發路線圖（Roadmap）— checkbox 形式：存儲層 MVP → 查詢引擎 → HTTP API → Web 管理介面 → 進階功能（匯入匯出、備份等）
|
||
7. 專案現狀與結構 — 如實說明目前為初始骨架，列出現有文件
|
||
8. 開發指南 — cargo build / test / run
|
||
9. 授權 — 標註尚未決定（TBD）
|
||
|
||
可選的小補充（一併執行）：在 .gitignore 追加 `*.db` / `*.sqlite*`，避免日後 SQLite 數據檔被誤提交（與 README 中「數據檔位置」說明呼應）。 |