AI talkingdocs

Project Readme：與Vite Framework，MongoDB，JWT，Node.js等ReactJS

目錄

1. 介紹
2. 使用的技術
3. 設置和配置
4. 項目結構
5. 身份驗證和授權
6. 數據存儲
7. 文件上傳
8. 前端和UI
9. API端點

介紹

我的項目是一個使用ReactJS Vite Framework，用於數據存儲的MongoDB，用於用戶身份驗證和授權的JWT的PDFCHAT應用程序，以及帶有Express.js的Node.js。它還利用各種庫和工具進行有效的開發，包括用於環境變量管理的DotEnv，Langchain及其矢量商店進行語言處理，用於文件上傳的multer以及向後端提出請求的AXIO。該項目的樣式配有尾風CSS和ShadCN框架，可用於光滑的用戶界面。

在後端，我使用帶有Express.js的Node.js來處理請求，並使用MongoDB來存儲用戶信息並管理用戶登錄。為了確保事情安全，我使用JSON Web令牌進行用戶身份驗證，確保只有授權用戶才能訪問項目的某些部分。

對於處理PDF文件，我使用了一個名為Multer的工具將文件及其位置存儲在數據庫中。然後，我處理了上傳的PDF，將它們分解成較小的部分，然後將它們存儲在Langchain提供的HNSW矢量商店中。這次旅程擴大了我的技能，使我更好地了解了Langchain和Rag等先進技術所提供的可能性。

使用的技術

• ReactJS ：一個流行的JavaScript庫，用於構建用戶界面。
• Vite框架：現代Web開發的快速構建工具和開發服務器。
• MongoDB ：用於存儲用戶信息的NOSQL數據庫。
• JWT（JSON IB令牌） ：用於安全身份驗證和授權。
• Node.js ：用於構建後端的JavaScript運行時。
• Express.JS ：用於處理路線的最小和靈活的Node.js應用程序框架。
• Dotenv ：用於管理環境變量，包括OpenAI API密鑰，Mongodb Atlas憑據和JWT Secrets。
• Langchain ：用於語言處理和文本分析。
• Multer ：用於處理文件上傳的中間件。
• AXIOS ：基於承諾的HTTP客戶端，用於向後端提出請求。
• Tailwind CSS ：實用領先的CSS框架，用於設計前端。
• SHADCN框架：使用陰影和效果增強UI。

設置和配置

在運行項目之前，您需要設置環境和配置變量：

1. 克隆存儲庫：首先將此存儲庫克隆到本地計算機。

2. 前端設置：

   • 導航到前端目錄並運行npm install以安裝前端依賴關係。
   • 使用npm run dev啟動前端。

3. 後端設置：

   • 導航到後端目錄並運行npm install以安裝後端依賴關係。
   • 在後端目錄中創建.env文件並設置以下變量：
     • PORT ：服務器上的端口號將運行。 （默認情況下為8080）
     • username ：MongoDB Atlas Connection用戶名。
     • password ：MongoDB Atlas連接密碼。
     • JWT_SECRET ：JWT代幣生成的秘密。
     • OPENAI_API_KEY ：OpenAI API密鑰。

4. 數據庫設置：

   • 使用Dotenv中提供自己的憑據配置MongoDB數據庫。

5. 開始後端：

   • 運行npm start啟動後端服務器。

6. 訪問應用程序：

   • 請訪問http://localhost:5173在瀏覽器中訪問該應用程序。
   • 打開默認值http://localhost:8080或http://localhost:PORT以訪問後端部分應用程序。

項目結構

項目結構分為兩個主要目錄：

• frontend ：包含帶打字稿的前端的所有ReactJS代碼。
• backend ：使用express.js包含node.js服務器的後端邏輯。

身份驗證和授權

我已經使用JWT（JSON Web令牌）進行用戶身份驗證和授權。當用戶註冊或登錄時，他們會收到一個代幣，必鬚髮送隨後的請求以訪問授權路由。

數據存儲

用戶信息存儲在靈活的NOSQL數據庫MongoDB中。用戶互動可牢固地存儲和檢索用戶數據。

文件上傳

我已經使用Multer，這是一種處理文件上傳的中間件，允許用戶上傳圖像或文檔之類的文件。此功能通過支持多媒體內容來增強用戶體驗。

前端和UI

前端使用尾風CSS和ShadCN框架設計了用戶友好的接口。它為用戶提供了響應迅速且具有視覺吸引力的體驗。

API端點

後端提供了各種API端點來管理用戶數據，身份驗證和文件上傳。這些終點是在代碼中記錄的，您可以在後端代碼庫中找到更多詳細信息。