readme generator

โครงการเครื่องกำเนิดไฟฟ้า README

ภาพรวมโครงการ

ยินดีต้อนรับสู่โครงการ README Generator! เครื่องมือที่เป็นนวัตกรรมนี้ได้รับการออกแบบมาเพื่อปรับปรุงกระบวนการสร้างไฟล์ README สำหรับโครงการซอฟต์แวร์ ด้วยการใช้ประโยชน์จากพลังของ generative AI ทำให้ผู้ใช้สามารถป้อนคำอธิบายสั้น ๆ เกี่ยวกับโครงการของตน รวมถึงวัตถุประสงค์ คุณสมบัติ และรายละเอียดทางเทคนิค และสร้างไฟล์ README.md ที่มีโครงสร้างดีและให้ข้อมูลตามแนวทางปฏิบัติที่ดีที่สุด

- คุณสมบัติ

• ส่วนต่อประสานที่ใช้งานง่าย : เว็บอินเตอร์เฟสให้วิธีที่ใช้งานง่ายในการป้อนรายละเอียดโครงการและสร้างไฟล์ README ได้อย่างง่ายดาย
• อินพุตไฟล์แบบไดนามิก : ผู้ใช้สามารถเพิ่มไฟล์ได้หลายไฟล์ด้วยชื่อที่กำหนดเองและส่วนย่อยของโค้ด ช่วยให้สามารถจัดทำเอกสารส่วนประกอบของโครงการได้อย่างครอบคลุม
• การสร้าง README แบบไดนามิก : สร้างไฟล์ README โดยอัตโนมัติตามอินพุตของผู้ใช้
• การบูรณาการ Generative AI : ใช้โมเดล Generative AI เพื่อสร้างไฟล์ README ตามอินพุตของผู้ใช้ ทำให้มั่นใจในความแม่นยำและความเกี่ยวข้อง
• การกำหนดค่าที่ปรับแต่งได้ : ผู้ใช้สามารถกำหนดการตั้งค่าการสร้าง เช่น อุณหภูมิ, top p, top k และการตั้งค่าความปลอดภัย เพื่อปรับแต่งเอาต์พุตตามความต้องการ
• เนื้อหาที่ขับเคลื่อนด้วย AI : ใช้ AI สร้างสรรค์เพื่อสร้างเนื้อหาที่น่าสนใจและให้ข้อมูล
• ปรับแต่งได้ : อนุญาตให้ผู้ใช้ปรับแต่งไฟล์ README ตามความต้องการของโครงการ
• การสนับสนุน Emoji : ปรับปรุง README ด้วยอิโมจิเพื่อประสบการณ์ผู้ใช้ที่น่าดึงดูดยิ่งขึ้น

รายละเอียดทางเทคนิค

โปรเจ็กต์ README Generator สร้างขึ้นด้วยการผสมผสานระหว่าง Flask สำหรับแบ็กเอนด์และ Express.js สำหรับฟรอนต์เอนด์ ใช้โมเดล Google Generative AI เพื่อสร้างเนื้อหา README เพื่อให้มั่นใจว่าผลลัพธ์มีคุณภาพสูงและมีความเกี่ยวข้อง

แบ็กเอนด์ ( app.py )

แบ็กเอนด์มีหน้าที่จัดการการสร้างเนื้อหา README รับอินพุตจากผู้ใช้ ประมวลผล และสื่อสารกับโมเดล AI ทั่วไปเพื่อสร้าง README

ส่วนหน้า ( public/app.js )

ส่วนหน้าจัดเตรียมอินเทอร์เฟซผู้ใช้แบบโต้ตอบสำหรับผู้ใช้เพื่อป้อนรายละเอียดโครงการและสร้าง README มันสื่อสารกับแบ็กเอนด์เพื่อส่งข้อมูลผู้ใช้และรับ README ที่สร้างขึ้น

เริ่มต้นใช้งาน

หากต้องการรัน README 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. ตั้งค่าตัวแปรสภาพแวดล้อม:
   • สร้างไฟล์ .env ในไดเร็กทอรี backend และเพิ่มคีย์ Generative AI API ของคุณ:

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. เริ่มเซิร์ฟเวอร์ Flask: python app.py
6. เริ่มต้นเซิร์ฟเวอร์ Node.js สำหรับส่วนหน้า:

การใช้งาน

1. เปิดเว็บเบราว์เซอร์ของคุณแล้วไปที่ http://localhost:3000
2. คลิกที่ "เพิ่มไฟล์" เพื่อกรอกรายละเอียดโครงการของคุณ
3. กรอกชื่อไฟล์และส่วนรหัส
4. คลิกที่ "สร้าง README" เพื่อสร้างไฟล์ README ของคุณ

- มีส่วนร่วม

รู้สึกอิสระที่จะมีส่วนร่วมและปรับปรุงโครงการนี้!

- ติดต่อ

หากคุณมีคำถามหรือข้อเสนอแนะ โปรดติดต่อ Chirag Joshi ได้ที่ [email protected]

---

ทำด้วย❤️โดย Chirag Joshi

ขอบคุณที่ใช้ README GPT !