ReadMeAI

- readmeai?

ภาพรวม

ReadMe Generator เป็นแพลตฟอร์มที่อนุญาตให้ผู้ใช้อัปโหลดรหัสไฟล์เดียวและอธิบายโครงการของพวกเขา AI สร้างรหัส Markdown ซึ่งสามารถแก้ไขได้แบบเรียลไทม์โดยใช้ตัวแก้ไขรหัสและการเปลี่ยนแปลงจะแสดงตัวอย่างทันที

readmeai ตอนนี้อยู่ที่ readmeai.live

การนำทาง

• - readmeai?
  • ภาพรวม
  • การนำทาง
  • - คุณสมบัติ
  • โครงสร้างไฟล์ (MVC)
  • ซ้อนเทค
  • การติดตั้ง
    • ในเครื่องในพื้นที่ของคุณ
    • ในเครื่องเสมือนของคุณ (ใช้ Docker)
  • การใช้งาน
    • ในเครื่องในพื้นที่ของคุณ
    • ใช้คอนเทนเนอร์ Docker
  • - คุณสมบัติสำหรับการเปิดตัวครั้งต่อไป
  • ?สนับสนุน
  • ✍ผู้เขียน

- คุณสมบัติ

• เนื้อหาที่ขับเคลื่อนด้วย AI : ใช้ Google AI เพื่อสร้างเนื้อหาที่มีความหมายและให้ข้อมูลสำหรับ readMe ของคุณรวมถึงคำอธิบายโครงการการใช้งานการติดตั้งและอื่น ๆ

• การปรับแต่ง : คุณสามารถปรับแต่งเนื้อหาที่สร้างขึ้นโดยใช้ ตัวแก้ไข ในตัวเพื่อรวมหรือยกเว้นส่วนที่เฉพาะเจาะจงเพื่อให้แน่ใจว่า readme ของคุณสะท้อนถึงความต้องการเฉพาะของโครงการของคุณ

• การสนับสนุน Markdown : ไฟล์ readme ที่สร้างขึ้นใช้ markdown ทำให้ง่ายต่อการจัดรูปแบบและจัดรูปแบบเอกสารโครงการของคุณ

• เว็บอินเตอร์เฟสที่ใช้งานง่าย : เข้าถึงเครื่องกำเนิดไฟฟ้าผ่านเว็บอินเตอร์เฟสที่ใช้งานง่ายโดยไม่จำเป็นต้องติดตั้งด้วยตนเอง

โครงสร้างไฟล์ (MVC)

• - API/ : มีไฟล์รหัสเพื่อเชื่อมต่อกับบุคคลที่สาม API (Google Palm 2)
• - คอนโทรลเลอร์/ : มีตรรกะทางธุรกิจทั้งหมดเพื่อดำเนินการตามคำขอโพสต์/ รับ
• - มุมมอง/ : มีไฟล์เพื่อแสดงผลที่ฝั่งไคลเอ็นต์
• - ข้อมูล/ : มี 'เทมเพลต' ซึ่งจะถือเทมเพลตเอาต์พุตและ 'output.md' ซึ่งจะทำเครื่องหมายเอาท์พุท
• - สาธารณะ/ : มี CSS และสคริปต์ด้านลูกค้า
• - เส้นทาง/ : ไฟล์เพื่อจัดการเส้นทางและเรียกใช้ฟังก์ชันคอนโทรลเลอร์ที่เกี่ยวข้องในเส้นทางเฉพาะ
• - อัปโหลด/ : ไดเรกทอรีนี้จะเก็บไฟล์ที่เซิร์ฟเวอร์ที่ได้รับจากฝั่งไคลเอ็นต์แล้วลบออกเมื่อเซสชันสิ้นสุดลง
• - Server.js : ไฟล์นี้เป็น เซิร์ฟเวอร์ด่วน หลักนี่คือไฟล์ที่จะดำเนินการบนเซิร์ฟเวอร์เริ่มต้น
• - DockerFile : ไฟล์นี้มีสคริปต์เพื่อเข้าร่วมโครงการ

ซ้อนเทค

• node.js: รันไทม์ฝั่งเซิร์ฟเวอร์
• Express: Node.js Framework
• - Google Palm API: โมเดลภาษาของ Google Pathways เป็นโมเดลภาษาขนาดใหญ่ที่ใช้พารามิเตอร์ 540 พันล้านพารามิเตอร์
• - EJS: เอ็นจิ้นเทมเพลตเพื่อแสดงผลและเพิ่มเนื้อหาแบบไดนามิกใน HTML ของคุณที่เซิร์ฟเวอร์
• - CSS: จัดแต่งทรงผม HTML
• JavaScript: เพื่อเพิ่มการโต้ตอบในส่วนหน้า

การติดตั้ง

ในเครื่องในพื้นที่ของคุณ

1. โคลนที่เก็บ
2. นำทางไปยังไดเรกทอรีโครงการ
3. เปิดเทอร์มินัลของคุณและเรียกใช้:

    npm install

ในเครื่องเสมือนของคุณ (ใช้ Docker)

1. โคลน repo และนำทางไปยังไดเรกทอรีโครงการ
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

---

หมายเหตุ: หากโครงการทำงานไม่ถูกต้องและแสดงข้อผิดพลาด CRBUG ในเว็บคอนโซลจากนั้นทำตามขั้นตอนต่อไปนี้

1. เปิด VSCODE ไปที่เมนู 'Run and Debug' ในแถบด้านซ้าย
2. คลิกที่ 'สร้างไฟล์ launch.json' และเลือก node.js ในเมนูป๊อปอัพ
3. ตอนนี้คลิกที่ไอคอนเล่นสามเหลี่ยมสีเขียวที่ด้านบนของแถบด้านข้าง 'Run and Debug' เดียวกัน
4. ตอนนี้ไปที่ http: // localhost: 3333

- คุณสมบัติสำหรับการเปิดตัวครั้งต่อไป

• การอนุญาต GitHub เพื่อเพิ่ม repo มากกว่าไฟล์เดียว
• AI ที่ผ่านการฝึกอบรมมากขึ้นเพื่อสร้าง readMe สำหรับโฟลเดอร์มากกว่าไฟล์
• เทมเพลตที่กำหนดเองผู้ใช้สามารถกำหนดคุณสมบัติ/ส่วนที่พวกเขาต้องการใน readme ของพวกเขา

?สนับสนุน

หากคุณพบปัญหาใด ๆ หรือมีคำถามโปรดสร้างปัญหาเกี่ยวกับที่เก็บ เรามาที่นี่เพื่อช่วย!

✍ผู้เขียน

• Gitanshu Sankhla (ผู้พัฒนาแบ็กเอนด์) -

• Vijay Banjara (นักพัฒนาส่วนหน้า) -
  

• Harsh Kumar (นักออกแบบ) -