makeread.me

makeread.me

เครื่องกำเนิด readme ที่ยอดเยี่ยมในการเริ่มต้นโครงการของคุณ!

สำรวจเอกสาร»

ดูตัวอย่าง รายงานข้อผิดพลาด คุณลักษณะการร้องขอ

สารบัญ

• สารบัญ
• เกี่ยวกับโครงการ
  • สร้างขึ้นด้วย
• เริ่มต้น
  • ข้อกำหนดเบื้องต้น
  • การติดตั้ง
• แผนงาน
• การบริจาค
• ใบอนุญาต
• ติดต่อ
• กิตติกรรมประกาศ
• สังเกต

เกี่ยวกับโครงการ

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

ในขณะที่มีเทมเพลต ReadMe ที่สามารถช่วยแก้ไขปัญหานี้ได้กระบวนการของการกรอกเทมเพลตเหล่านี้ด้วยตนเองอาจใช้เวลานานและน่าเบื่อ นั่นคือสิ่งที่โครงการของเรา Makeread.me เข้ามา

แนะนำ makeread.me เครื่องกำเนิด readme อัตโนมัติที่สามารถปฏิวัติวิธีการสร้างเอกสารโครงการของคุณ มันถูกออกแบบมาเพื่อ:

• ประหยัดเวลาอันมีค่าของคุณเพิ่มการมุ่งเน้นการพัฒนา
• ทำงานซ้ำซ้อนโดยอัตโนมัติและ
• ใช้หลักการแห้ง (อย่าทำซ้ำตัวเอง) ในเอกสารของคุณ

ฟรีโอเพ่นซอร์สและปรับแต่งได้สูง อย่าลังเลที่จะปรับเปลี่ยนเทมเพลตของเราให้เหมาะกับความต้องการของคุณ หากคุณพบว่าองค์ประกอบเฉพาะหายไปคุณยินดีต้อนรับมากกว่าที่จะมีส่วนร่วมและขยายโครงการ

เราทำให้มันง่ายสำหรับคุณที่จะมีส่วนร่วมในโครงการโดยใช้เทมเพลต Nunjucks และ JSON สำหรับการทำแผนที่โปรแกรม เพลิดเพลินไปกับประโยชน์ของเอกสารโครงการที่ชัดเจนและรัดกุมด้วย makeread.me!

สร้างขึ้นด้วย

โครงการนี้สร้างขึ้นด้วยเทคโนโลยีต่อไปนี้:

• next.js
• ตอบโต้
• Shadcn/ui
• ฟอร์มเบ็ดตอบสนอง
• ตัวพิมพ์ใหญ่
• ด่วน

เริ่มต้น

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

ข้อกำหนดเบื้องต้น

โครงการนี้ต้องการเส้นด้ายที่จะติดตั้งในระบบของคุณ หากคุณไม่ได้ติดตั้งคุณสามารถทำตามขั้นตอนเหล่านี้:

• ติดตั้งเส้นด้ายทั่วโลกโดยใช้ NPM (Node Package Manager) เปิดเทอร์มินัลของคุณและเรียกใช้:

  npm install -g yarn

  โปรดตรวจสอบให้แน่ใจว่าคุณติดตั้ง Node.js และ NPM ก่อนที่จะใช้เส้นด้าย

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

  yarn --version

  หากมีการติดตั้งเส้นด้ายอย่างถูกต้องเทอร์มินัลของคุณควรแสดงเวอร์ชันของเส้นด้ายที่ติดตั้งบนเครื่องของคุณ

ตอนนี้คุณพร้อมที่จะใช้เส้นด้ายสำหรับการจัดการและกำหนดเวอร์ชันการพึ่งพาโครงการของคุณ!

การติดตั้ง

โปรดทำตามขั้นตอนต่อไปนี้สำหรับการติดตั้งที่ประสบความสำเร็จ:

1. โคลนที่เก็บ: เริ่มต้นด้วยการโคลนที่เก็บไปยังเครื่องในพื้นที่ของคุณ

    https://github.com/ShaanCoding/makeread.me
   

2. ติดตั้งแพ็คเกจส่วนหน้า: นำทางไปยังไดเรกทอรี "/frontend" และติดตั้งแพ็คเกจเส้นด้ายที่ต้องการโดยดำเนินการคำสั่งต่อไปนี้ในเทอร์มินัลของคุณ:

   yarn install

3. ติดตั้งแพ็คเกจแบ็กเอนด์: ในทำนองเดียวกันนำทางไปยังไดเรกทอรี "/แบ็กเอนด์" และติดตั้งแพ็คเกจเส้นด้ายที่ต้องการโดยดำเนินการคำสั่งต่อไปนี้ในเทอร์มินัลของคุณ:

   yarn install

4. ตั้งค่าสภาพแวดล้อม:

   • ในไดเรกทอรี "/แบ็กเอนด์" คัดลอกเนื้อหาของไฟล์ ".env.example" และสร้างไฟล์ใหม่ชื่อ ".env" ปรับตัวแปรสภาพแวดล้อมตามความต้องการของคุณหรือคุณสามารถทิ้งไว้ตามที่เป็นอยู่

   • นำทางไปที่ "Frontend/API/สร้าง/ReadMeGenerator.TS" และตั้งค่าพารามิเตอร์พื้นฐานไปยังเส้นทาง API แบ็กเอนด์ของคุณ ตัวอย่างเช่นหากคุณใช้แบ็กเอนด์บนเซิร์ฟเวอร์ท้องถิ่นของคุณที่พอร์ต 8080 คุณควรตั้งค่า:

     BASE: "http://localhost:8080/api" ;

5. เรียกใช้ไดเรกทอรีแบ็กเอนด์: นำทางไปยังไดเรกทอรี "/แบ็กเอนด์" และพิมพ์คำสั่งต่อไปนี้ในเทอร์มินัลของคุณเพื่อเรียกใช้เซิร์ฟเวอร์แบ็กเอนด์ของคุณ:

   yarn dev

6. เรียกใช้ส่วนหน้า: ในที่สุดนำทางไปยังไดเรกทอรี "/frontend" และพิมพ์คำสั่งต่อไปนี้ในเทอร์มินัลของคุณเพื่อเรียกใช้เซิร์ฟเวอร์ส่วนหน้าของคุณ:

   yarn dev

   ตอนนี้แอปพลิเคชันของคุณควรจะทำงานได้สำเร็จ!

แผนงาน

แผนงานรวมถึงเป้าหมายทั้งที่เสร็จสมบูรณ์และในอนาคต นี่คือสิ่งที่เราทำสำเร็จและรอคอย:

• เพิ่มรุ่น Backend Swagger
• เพิ่มแบ็กเอนด์
• ตั้งค่า CI/CD บนรถไฟ
• อนุญาตการสร้างฟิลด์อินพุตแบบไดนามิกโดยใช้ไฟล์ JSON
  • textarea
  • ป้อนข้อมูล
  • วัตถุ
  • อาร์เรย์
• อนุญาตให้ผู้ใช้ตั้งค่าลำดับส่วนประกอบหรือลบ
• อนุญาตให้ใช้เทมเพลตผ่าน nunjucks
• เพิ่มการวิเคราะห์ที่น่าเชื่อถือ
• เพิ่มเทมเพลตเครื่องกำเนิดไฟฟ้า readme เก่า
• เพิ่มเทมเพลตเพิ่มเติม
• ย้ายตรรกะการแสดงผลไปยังแบ็กเอนด์ด้วย debounce
• แทนที่ useeffect ด้วย react query
• เพิ่มแคช
• เขียนบทความแนวปฏิบัติที่ดีที่สุด readme
• หลีกเลี่ยงการชนที่สำคัญเมื่อใช้ชื่อที่ไม่ใช่ชื่อเป็นรหัสในเทมเพลต

เรายังคงมุ่งมั่นที่จะปรับปรุงและขยายขีดความสามารถของ Makeread.me เพื่อมอบประสบการณ์การสร้าง ReadMe ที่มีประสิทธิภาพและราบรื่นให้กับผู้ใช้ของเรา

ดูปัญหาเปิดสำหรับรายการคุณสมบัติที่เสนอทั้งหมด (และปัญหาที่รู้จัก)

การบริจาค

การมีส่วนร่วมคือสิ่งที่ทำให้ชุมชนโอเพ่นซอร์สเป็นสถานที่ที่น่าทึ่งในการเรียนรู้สร้างแรงบันดาลใจและสร้าง การมีส่วนร่วมใด ๆ ที่คุณทำ จะได้รับการชื่นชมอย่างมาก

หากคุณมีข้อเสนอแนะที่จะทำให้สิ่งนี้ดีขึ้นโปรดแยก repo และสร้างคำขอดึง นอกจากนี้คุณยังสามารถเปิดปัญหาด้วยแท็ก "การปรับปรุง" อย่าลืมให้โครงการเป็นดารา! ขอบคุณอีกครั้ง!

1. แยกโครงการ
2. สร้างสาขาคุณลักษณะของคุณ ( git checkout -b feature/AmazingFeature )
3. กระทำการเปลี่ยนแปลงของคุณ ( git commit -m 'Add some AmazingFeature' )
4. Push to the Branch ( git push origin feature/AmazingFeature )
5. เปิดคำขอดึง

ใบอนุญาต

แจกจ่ายภายใต้ใบอนุญาต Mozilla Public License 2.0 ดูใบอนุญาต Mozilla Public License 2.0 สำหรับข้อมูลเพิ่มเติม

ติดต่อ

หากคุณมีคำถามหรือข้อเสนอแนะอย่าลังเลที่จะติดต่อเรา:

• ยกประเด็นเกี่ยวกับที่เก็บ: ที่เก็บ GitHub
• เชื่อมต่อกับเราบน Twitter: @shaancoding

กิตติกรรมประกาศ

ขอขอบคุณเป็นพิเศษสำหรับการบริจาคการสนับสนุนและแรงบันดาลใจของพวกเขา:

• makeread.me
• Othneil Drew

สังเกต

readme นี้ถูกสร้างขึ้นโดยใช้ makeread.me