Client Side Cache Based Search Engine

客戶端基於快取的搜尋引擎

一款輕量、無資料庫的搜尋引擎，旨在為靜態內容（HTML、TXT、MD 檔案）和動態筆記提供快速且有效率的搜尋功能。該專案透過客戶端快取系統增強了使用者體驗，該系統可以加快搜尋檢索速度，減少伺服器負載，並透過服務工作執行緒提供離線功能。

---

目錄

• 客戶端基於快取的搜尋引擎

• 1. 主螢幕

• 2. 搜尋結果

• 3. 離線訪問

• 4. 筆記功能

• 快取目錄設定

• 快取過期

• 目錄

• 概述

• 特徵

• 它是如何運作的

• 系統架構

• 安裝

• 用法

• 配置

• 截圖

• 未來的增強功能

• 執照

---

概述

客戶端基於快取的搜尋引擎旨在解決傳統資料庫驅動系統中檢索時間慢的問題，特別是對於小型應用程式。透過利用客戶端快取技術，該專案允許快速存取靜態內容和使用者生成的註釋，而無需重複的伺服器查詢或複雜的資料庫設定。它還具有離線搜尋功能，即使沒有網路連接，用戶也可以存取常用的文件和筆記。

---

特徵

• 快速搜尋：快速索引和檢索本機靜態檔案（HTML、TXT、MD）和使用者產生的筆記中的內容。

• 客戶端快取：經常存取的文件在本地緩存，減少載入時間並最大限度地減少伺服器請求。

• 離線存取：整合服務工作者允許使用者在離線時搜尋和存取文件和筆記。

• 筆記管理：包括一個簡單的筆記應用程序，允許使用者建立、編輯和保存筆記，這些筆記也會被快取以便快速檢索。

---

它是如何運作的

1. 檔案索引：指定目錄中的檔案在首次搜尋時建立索引並快取以實現更快的存取。

2. 客戶端快取：索引內容儲存在快取中，允許搜尋引擎跳過經常存取的檔案的檔案讀取。

3. Service Worker ：Service Worker 快取重要檔案並提供離線支持，使筆記和靜態內容無需網路連線即可使用。

4. 即時檢索：動態筆記建立後立即緩存，實現線上和離線即時存取。

---

系統架構

該系統是圍繞客戶端快取和服務工作者模型設計的，無需資料庫。這是一個簡化的架構：

圖解TD
    UI[使用者介面] -->|搜尋請求|搜尋引擎
    搜尋引擎-->|快取命中？快取
    快取-->|是| RetrieveFromCache[從快取檢索]
    從快取中檢索 --> 顯示結果
    搜尋引擎-->|否| ReadFile[從目錄讀取檔案]
    ReadFile --> IndexContent[索引與快取內容]
    索引內容 --> 快取
    IndexContent --> DisplayResults[顯示結果]
    ServiceWorker[Service Worker] --> 離線支持
    筆記[筆記儲存] --> 快取
    註釋 --> ServiceWorker

---

安裝

請依照以下步驟在本機設定項目：

1. 克隆儲存庫

   git 克隆 https://github.com/vansh-codes/Client-Side-Cache-Based-Search-Engine.git

2. 導航至目錄

   cd 用戶端基於快取的搜尋引擎

3. 設定 XAMPP 或本機 PHP 伺服器

• 將項目放置在適當的 XAMPP 目錄中（例如C:/xampp/htdocs/ ）。

• 啟動 Apache 伺服器。

4. 造訪項目開啟瀏覽器並前往http://localhost/Client-Side-Cache-Based-Search-Engine 。

---

用法

1. 搜尋內容：使用搜尋列在索引檔案和註解中尋找關鍵字。

2. 記筆記：建立並保存筆記，這些筆記將被快取以供快速存取和離線使用。

3. 離線存取：首次存取後，可以使用 Service Worker 離線存取檔案和筆記。

---

配置

快取目錄設定

在設定檔中設定內容和筆記儲存的目錄路徑：

• CACHE_DIR ：儲存快取檔案的路徑。

• 內容資料夾：修改content/目錄下靜態檔案的路徑。

• 筆記資料夾：修改notes/目錄下動態筆記的路徑。

快取過期

調整快取過期設定以清除過期檔案並根據需要刷新內容。

未來的增強功能

• 進階搜尋功能：實作模糊搜尋和關鍵字突出顯示，以實現更直觀的搜尋。

• 增強的快取管理：引入快取過期策略以實現更好的儲存管理。

• 多格式筆記：支援其他筆記格式（TXT、MD、HTML）並自動快取它們以便更快地檢索。

執照

該項目已獲得 MIT 許可證的許可。有關詳細信息，請參閱許可證文件。

享受快速、高效且支援離線的搜尋！