หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

- ภาพรวม

EasyReadMe เป็นโครงการที่ทำให้การสร้าง README ง่ายขึ้นโดยการสร้าง readmes ที่น่าทึ่งทางสายตาโดยใช้เทมเพลตที่ออกแบบไว้ล่วงหน้าและ AI รองรับการสร้าง readmes สำหรับ JavaScript/typeScript, Rust, Java, GO, PHP และ Python มันขึ้นอยู่กับเทคโนโลยีและห้องสมุดที่หลากหลายรวมถึง React, Tailwind CSS, Tiptap, Openai และอีกมากมาย

- สารบัญ

  • ❤คุณสมบัติ

  • กองซ้อน

  • สรุปโครงการ

  • การตั้งค่า

  • วิ่งในพื้นที่

  • ️แผนงาน

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

  • - ใบอนุญาต

คุณสมบัติ

บทนำ. mp4

รายการเทมเพลต

แม่แบบ. mp4

ปรับแต่ง readme

กำหนดเอง. mp4

ส่วน AI

ai-sections.mp4

คำสั่งแบบอินไลน์

คำสั่ง mp4

เมนูฟอง

Bubble-menu.mp4

URL ภาพแบนเนอร์ที่แก้ไขได้

Update-banner.mp4

ฟรีเครดิต AI, คีย์ API แบบกำหนดเอง, การรันท้องถิ่น

api-Offline-Generations.mp4

กองซ้อน

  • ถัดไป: เฟรมเวิร์กสำหรับการสร้างแอปพลิเคชันตอบสนองเซิร์ฟเวอร์ที่แสดงผล
  • React: A JavaScript Library สำหรับการสร้างส่วนต่อประสานผู้ใช้
  • TypeScript: superset ที่พิมพ์ของ JavaScript ที่รวบรวมเป็นจาวาสคริปต์ธรรมดา
  • Shadcn/UI: ให้ส่วนประกอบที่ออกแบบมาอย่างสวยงามสำหรับ UI
  • Tailwindcss: เฟรมเวิร์ก CSS ยูทิลิตี้แรกสำหรับการพัฒนา UI อย่างรวดเร็ว
  • VAUL: ส่วนประกอบลิ้นชักที่ไม่มีการตอบสนองสำหรับการตอบสนอง
  • Sonner: องค์ประกอบขนมปังปิ้งที่มีความคิดเห็นสำหรับ React
  • TIPTAP/CORE: เฟรมเวิร์กโปรแกรมแก้ไขข้อความที่ปรับแต่งได้สูงและขยายได้สูง
  • SWR: จัดการการดึงข้อมูลการแคชและการซิงโครไนซ์กับเซิร์ฟเวอร์
  • Zustand: ห้องสมุดการจัดการสถานะขนาดเล็กเร็วและปรับขนาดได้
  • ลูไซด์: ไอคอนที่สวยงามและสม่ำเสมอ

สรุปโครงการ

  • SRC : ไดเรกทอรีรหัสต้นฉบับหลัก
  • SRC/APP : มีตรรกะและส่วนประกอบของแอปพลิเคชันหลัก
  • SRC/ส่วนประกอบ : ส่วนประกอบ UI ที่ใช้ซ้ำได้
  • SRC/Hooks : Hooks React ที่กำหนดเองสำหรับการจัดการสถานะและผลข้างเคียง
  • SRC/LIB : ฟังก์ชั่นยูทิลิตี้และโมดูลผู้ช่วย
  • SRC/Services : โมดูลสำหรับการโต้ตอบกับ API ภายนอก
  • SRC/Styles : โมดูลสไตล์และ CSS ระดับโลก
  • src/types : คำจำกัดความประเภท typescript
  • SRC/UTILS : ฟังก์ชั่นยูทิลิตี้เบ็ดเตล็ด
  • สาธารณะ : ไดเรกทอรีสาธารณะสำหรับสินทรัพย์คงที่และสร้างผลผลิต

การตั้งค่า

openai_api_key

  • ไปที่เว็บไซต์ OpenAI
  • ลงชื่อเข้าใช้บัญชีของคุณหรือสร้างบัญชีใหม่
  • นำทางไปยังการตั้งค่า API ของคุณ
  • สร้างคีย์ลับ
  • คัดลอกคีย์ลับที่สร้างขึ้น

github_access_token

  • ไปที่เว็บไซต์ GitHub
  • ลงชื่อเข้าใช้บัญชีของคุณหรือสร้างบัญชีใหม่
  • นำทางไปยังการตั้งค่าบัญชีของคุณ
  • ไปที่ส่วน "การตั้งค่านักพัฒนา"
  • สร้างโทเค็นการเข้าถึงส่วนบุคคลใหม่ด้วยสิทธิ์ที่จำเป็น

KV_REST_API_URL และ KV_REST_API_TOKEN

  • ไปที่เว็บไซต์ vercel
  • ลงชื่อเข้าใช้บัญชีของคุณหรือสร้างบัญชีใหม่
  • นำทางไปยังส่วนการจัดเก็บ
  • สร้างฐานข้อมูล KV ใหม่
  • คัดลอก KV_REST_API_URL และ KV_REST_API_TOKEN จากใต้แท็บ. env.local

ollama_url

  • ดาวน์โหลด Ollama และให้มันทำงาน
  • หากอินสแตนซ์ของ Ollama ของคุณไม่ทำงานบน IP-address และพอร์ตเริ่มต้นให้เปลี่ยนตัวแปรในไฟล์. env.example เพื่อให้พอดีกับ usecase ของคุณ

วิ่งในพื้นที่

1. โคลนนิ่งที่เก็บ EasyReadMe: 

git clone https://github.com/xavimondev/easyreadme

2. rename .env.example เป็น .env : 

mv .example.env .env

3. ติดตั้งการพึ่งพา: 

 # bun
bun install
# pnpm
pnpm install
# npm
npm install
# yarn
yarn install

6. เริ่มโหมดการพัฒนา: 

 # bun
bun dev
# pnpm
pnpm dev
# npm
npm run dev
# yarn
yarn dev

สำคัญ

แม้จะมีเทมเพลตสำหรับแพ็คเกจ NPM แต่ก็ยังมีงานอีกมากที่ต้องทำและวิจัยเกี่ยวกับวิธีการรับประเภทที่ถูกต้องจากแพ็คเกจ

แผนงาน

  • เพิ่มการสนับสนุนสำหรับภาษาการเขียนโปรแกรมเพิ่มเติม
  • เพิ่มตัวเลือก "กับ Emojis"

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

  • แอนิเมชั่น Sparkles ถูกนำมาจากแหล่งข้อมูลที่ยอดเยี่ยมนี้ที่สร้างขึ้นโดย Josh W. Comeau
  • ลูกปารอบ ๆ ปุ่ม "คัดลอกรหัส" ถูกสร้างขึ้นโดยใช้เว็บ Lucide เป็นข้อมูลอ้างอิง

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ ใบอนุญาต MIT - ดูไฟล์ใบ อนุญาต MIT สำหรับรายละเอียด

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