ReadMeAI

？ redmeai？

概述

README生成器是一個平台，允許用戶上傳單文件代碼並描述其項目。 AI生成了降價代碼，該代碼可以使用代碼編輯器實時編輯，並立即預覽更改。

readmeai現在住在readmeai.live

導航

• ？ redmeai？
  • 概述
  • 導航
  • ？特徵
  • 文件結構（MVC）
  • 技術堆棧
  • 安裝
    • 在您當地的機器中
    • 在您的虛擬機（使用Docker）中
  • 用法
    • 在您當地的機器中
    • 使用Docker容器
  • ？下一個版本的功能。
  • ？支持
  • ✍️作者

？特徵

• AI驅動的內容：它使用Google AI為您的讀書人生成有意義且有用的內容，包括項目描述，使用情況，安裝等。

• 自定義：您可以使用內置編輯器自定義生成的內容以包含或排除特定部分，以確保您的閱讀文件反映您的項目的獨特需求。

• 降價支持：生成的讀數文件使用Markdown，使您可以易於格式化和样式的項目文檔。

• 用戶友好的Web界面：通過用戶友好的Web界面訪問生成器，從而消除了對手動設置的需求。

文件結構（MVC）

• ？ API/ ：包含連接到第三方API的代碼文件（Google Palm 2）
• ？控制器/ ：包含所有業務邏輯以在郵政/獲取請求上執行的所有業務邏輯。
• ？視圖/ ：包含在客戶端渲染的文件。
• ？數據/ ：包含將保存輸出模板和“輸出”的“模板”，該模板將輸出降低。
• ？公共/ ：包含客戶端CS和腳本。
• ？路由/ ：文件以處理路由並在特定路線上調用相應的控制器功能。
• ？上傳/ ：此目錄將保存服務器從客戶端接收到的文件，然後在會話結束後刪除它們。
• ？ server.js ：此文件是主要的Express服務器，這是將在啟動服務器上執行的文件。
• ？ Dockerfile ：此文件包含用於容器化項目的腳本。

技術堆棧

• node.js：服務器端運行時。
• express：node.js框架。
• ？ Google Palm API：Google Pathways語言模型是基於5400億個參數變壓器的大語言模型。
• ？ EJS：模板引擎以渲染並在服務器上的HTML中添加動態內容。
• ？ CSS：造型HTML模板。
• JavaScript：在前端添加交互性。

安裝

在您當地的機器中

1. 克隆存儲庫。
2. 導航到項目目錄。
3. 打開終端並運行：

    npm install

在您的虛擬機（使用Docker）中

1. 克隆回購併導航到項目目錄。
2. 打開終端並鍵入以下命令：

     docker build -t gitax18/readmeai . 

用法

在您當地的機器中

1. 更改為項目目錄。
2. 打開您的終端並鍵入以下命令：

    npm start

3. 該應用程序將在http：// localhost上運行：3333

使用Docker容器

1. 要啟動容器，請鍵入以下命令：

    docker run -it -p 3333:3333 gitax18/readmeai

2. 現在，該應用程序將在http：// localhost上運行：3333

---

注意：如果項目無法正常運行並顯示Web控制台中的CRBBUG錯誤，請按照以下步驟操作。

1. 在左側欄中打開Vscode訪問“運行和調試”菜單。
2. 單擊“創建啟動”文件”，然後在彈出菜單中選擇node.js。
3. 現在，單擊同一“ Run and Debug”側邊欄上頂部的Green Triangular Play圖標。
4. 現在訪問http：// localhost：3333

？下一個版本的功能。

• GitHub授權添加回購而不是單個文件。
• 訓練有素的AI可以為文件夾而不是文件生成讀數。
• 自定義模板，用戶可以定義他們想要的功能/部分。

？支持

如果您遇到任何問題或有疑問，請隨時在存儲庫上創建問題。我們在這里為您提供幫助！

✍️作者

• Gitanshu Sankhla（後端開發人員） -

• Vijay Banjara（前端開發人員） -
  

• 苛刻的庫馬爾（設計師） -