readme generator

自述文件產生器項目

項目概況

歡迎來到自述文件產生器專案！這項創新工具旨在簡化為軟體專案創建自述文件的過程。透過利用生成式人工智慧的力量，它允許使用者輸入專案的簡短描述，包括其目的、功能和技術細節，並按照最佳實踐生成結構良好且資訊豐富的 README.md 檔案。

？特徵

• 使用者友善的介面：網路介面提供了一種直觀的方式來輸入項目詳細資訊並輕鬆生成自述文件。
• 動態文件輸入：使用者可以新增具有自訂名稱和程式碼片段的多個文件，從而實現專案元件的全面文件記錄。
• 動態自述文件產生：根據使用者輸入自動產生自述文件。
• 生成式人工智慧整合：利用生成式人工智慧模型根據使用者輸入產生自述文件，確保準確性和相關性。
• 可自訂的配置：使用者可以配置生成設置，例如溫度、top p、top k 和安全性設置，以根據自己的喜好自訂輸出。
• 人工智慧驅動的內容：利用生成式人工智慧來創造引人入勝且資訊豐富的內容。
• 可自訂：允許使用者根據專案的需要自訂自述文件。
• 表情符號支援：使用表情符號增強自述文件，以獲得更具吸引力的使用者體驗。

技術細節

README Generator 專案是使用後端的 Flask 和前端的 Express.js 組合建構的。它使用 Google Generative AI 模型產生 README 內容，確保高品質和相關的產出。

後端（ app.py ）

後端負責處理 README 內容的產生。它接收使用者輸入，對其進行處理，並與生成式 AI 模型進行通訊以產生自述文件。

前端（ public/app.js ）

前端提供了一個互動式使用者介面，供使用者輸入專案詳細資訊並產生自述文件。它與後端通信以發送用戶輸入並接收生成的自述文件。

入門

要執行自述文件 GPT 嗎？在本地，請執行以下步驟：

1. 克隆儲存庫： git clone https://github.com/chiragjoshi12/readme-generator.git
2. 導覽至專案目錄： cd readme-generator
3. 安裝依賴項：
   • 對於 Flask 後端：

      cd backend
     pip install -r requirements.txt
     

   • 對於 Node.js 前端：

      cd public
     npm install
     

4. 設定環境變數：
   • 在backend目錄中建立一個.env檔案並新增您的 Generative AI API 金鑰：

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. 啟動 Flask 伺服器： python app.py
6. 啟動前端的 Node.js 伺服器：

用法

1. 開啟 Web 瀏覽器並導航至http://localhost:3000 。
2. 點擊“新增檔案”以輸入您的項目詳細資料。
3. 填寫檔案名稱和代碼部分。
4. 按一下「產生自述文件」以產生自述文件。

？貢獻

請隨意貢獻和改進這個項目！

？接觸

如果您有任何問題或建議，請隨時透過 [email protected] 聯絡 Chirag Joshi。

---

由 Chirag Joshi 與 ❤️ 製作

感謝您使用自述文件 GPT？