kirimase

บันทึก

หมายเหตุ: มีเพียงข้อบกพร่องที่สำคัญเท่านั้นที่ได้รับการแก้ไขในขณะนี้เนื่องจากเรากำลังวางแผนเขียนใหม่อย่างสมบูรณ์ในอนาคตอันใกล้นี้!

Kirimase

Kirimase เป็นเครื่องมือบรรทัดคำสั่งสำหรับ การสร้างแอปเต็มรูปแบบ next.js เร็วขึ้น มันเพิ่มความชาร์จเวิร์กโฟลว์การพัฒนาของคุณช่วยให้คุณสามารถรวมแพ็คเกจและทรัพยากรนั่งร้านสำหรับแอปพลิเคชันของคุณได้อย่างรวดเร็วโดยคำนึงถึงแนวทางปฏิบัติที่ดีที่สุด

ดูตัวอย่างล่าสุดที่นี่

ตรวจสอบการสอนอย่างเป็นทางการที่นี่

คุณสมบัติ

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

เริ่มต้นอย่างรวดเร็ว

ติดตั้ง Kirimase CLI ทั่วโลก:

npm install -g kirimase

หากคุณยังไม่มีแอพ NextJS ให้เรียกใช้ Create-Next-App ด้วยตัวจัดการแพ็คเกจที่คุณต้องการ

จากนั้นเรียกใช้คำสั่งต่อไปนี้ภายในไดเรกทอรีของโครงการของคุณ:

kirimase init

หมายเหตุ: Kirimase ไม่สามารถใช้งานได้กับไดเรกทอรีหน้า

คำสั่ง

เรียกใช้คำสั่งเหล่านี้ภายในไดเรกทอรีของแอป NextJS ของคุณ:

1. kirimase add

เริ่มต้นและกำหนดค่าแพ็คเกจต่อไปนี้สำหรับโครงการ Next.js ของคุณจัดหมวดหมู่เป็น:

orm

อมตะ

• ขึ้นอยู่กับประเภทฐานข้อมูลที่คุณเลือก (PostgreSQL, MySQL, SQLITE), Kirimase ตั้งค่าไฟล์ที่จำเป็นสำหรับ Drizzle-orm, Drizzle-Zod สำหรับการตรวจสอบและและ Drizzle-Kit เพื่อจัดการการย้ายถิ่น
• สคริปต์ถูกเพิ่มอัตโนมัติเป็น package.json สำหรับการใช้งาน Drizzle-Kit ทันที

ปริซึม

• Kirimase ตั้งค่าไฟล์ที่จำเป็นสำหรับ PRISMA ด้วย ZOD-PRISMA สำหรับการตรวจสอบความถูกต้อง

---

การรับรองความถูกต้อง

Auth.js

• สร้างไฟล์สำหรับ auth.js (Next-Auth) รวมถึงอะแดปเตอร์ฝนตกปรอยๆล่าสุด (สำหรับ PlanetScale การอ้างอิงจะถูกแยกออกเนื่องจากไม่สนับสนุนกุญแจต่างประเทศ)
• สร้างองค์ประกอบการลงชื่อเข้าใช้ทั่วไปสำหรับการใช้งานทันทีภายในโครงการถัดไปของคุณ
• ห่อโครงร่างรูทด้วยผู้ให้บริการรับรองความถูกต้องและสร้างยูทิลิตี้สำหรับการตรวจสอบรับรองความถูกต้องและเปลี่ยนเส้นทางในเส้นทางถัดไปของคุณ

พนักงาน

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

ลูเซีย

• สร้างไฟล์สำหรับ Lucia รวมถึงการกำหนดค่าที่จำเป็นทั้งหมด
• สร้างเส้นทาง UI และ API สำหรับการลงชื่อเข้าใช้และลงทะเบียน

ชนิด

• สร้างไฟล์สำหรับ kinde รวมถึงการกำหนดค่าที่จำเป็นทั้งหมด
• สร้างการลงชื่อเข้าใช้ส่วนประกอบและตัวจัดการเส้นทาง

---

อื่น

TRPC

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

Shadcn-ui

• ติดตั้งและกำหนดค่า Shadcn-Ui รวมถึงปุ่มและส่วนประกอบขนมปังปิ้ง
• แทรก Toast-Provider ( <Toaster /> ) ลงในเค้าโครงรูทสำหรับการแจ้งเตือนขนมปังปิ้งทันทีในแอปถัดไปของคุณ

แถบ

• ติดตั้งและกำหนดค่า Stripe ภายในโครงการถัดไปของคุณเพื่อให้คุณสามารถเริ่มรับการชำระค่าสมัครสมาชิก

ส่งคืน

• ติดตั้งและกำหนดค่าใหม่

Kirimase ยังเพิ่มคีย์ที่เกี่ยวข้องให้กับ .env ของคุณซึ่งคุณจะต้องให้ค่าสำหรับ

2. kirimase generate

คล้ายกับ rails scaffold แต่สำหรับ next.js:

Kirimase สร้าง:

a) รุ่น:

• สร้างสคีมาละอองที่มีประเภทคอลัมน์ตามรสชาติ SQL และผู้ให้บริการฐานข้อมูลของคุณ
• ใช้ Drizzle-Zod เพื่อสร้าง zod schemas สำหรับการตรวจสอบส่วนหน้าและการตรวจสอบแบ็กเอนด์
• สร้างการสืบค้นและการกลายพันธุ์สำหรับการดำเนินการ CRUD พิมพ์อย่างเต็มที่และปรับให้เหมาะสมสำหรับการบริโภคผ่านส่วนหน้าต่อไป

b) คอนโทรลเลอร์:

• ให้ตัวเลือกสำหรับนั่งร้าน TRPC การกระทำของเซิร์ฟเวอร์และ/หรือเส้นทาง API
• ใช้ zod schemas จากรุ่นสำหรับการตรวจสอบความถูกต้องของคำขอ
• รวมถึงการจัดการข้อผิดพลาดในตัวสำหรับเส้นทาง API และการเพิ่มเส้นทาง TRPC อัตโนมัติไปยังเราเตอร์รูท

c) มุมมอง:

• มุมมองนั่งร้านโดยใช้ Shadcn-UI เพื่อเปิดใช้งานการดำเนินการ CRUD ทันที (รวมถึงฟิลด์ที่เลือกสำหรับการเพิ่มความสัมพันธ์และวันที่สำหรับวันที่)
• ตัวเลือกในการใช้แบบฟอร์มเรียลฮุคกับ TRPC หรือปฏิกิริยาธรรมดา

รันในโหมดที่ไม่โต้ตอบ

ณ ของ v0.0.23 คุณสามารถเรียกใช้ kirimase init และ kirimase add ทั้งหมดผ่านบรรทัดคำสั่งดังต่อไปนี้:

kirimase init -sf yes -pm bun --orm prisma -db pg -a next-auth -ap github discord -mp trpc stripe resend -cl shadcn-ui -ie yes

สั่งการ	ธงสั้น	ตัวเลือกยาว	คำอธิบาย	การโต้แย้ง
การเริ่มต้น	-	-	เริ่มต้นและกำหนดค่า kirimase	-
-	-ชม	-ไม่มีหัว	เริ่มต้นโดยไม่มี UI ใด ๆ	yes หรือ no
-	-sf	-โฟลเดอร์ -Src	ใช้โฟลเดอร์ SRC	yes หรือ no
-	-น.	-ผู้จัดการแพคเกจ	ผู้จัดการแพ็คเกจ	<pm>
-	-cl	-คอมโพเนนต์-ลีบ	ไลบรารีส่วนประกอบ	<component-lib>
-	-o	-อวกาศ	orm	<orm>
-	-DB	-DB	ฐานข้อมูล ("pg", "mysql", "sqlite")	<db>
-	-DBP	-ผู้ให้บริการ DB	ผู้ให้บริการฐานข้อมูล - สำคัญหากใช้ฝนตกตะกอน	<dbp>
-	-A	-มังกร	รับรองความถูกต้อง	<auth>
-	-AP	-ผู้จัดหา	ผู้ให้บริการรับรองความถูกต้อง (หากใช้ ATH-AUTH)	<providers>
-	-MP	-แพคเกจ	แพ็คเกจ ("TRPC", "Shadcn-ui", "Resend")	<packages>
-	-เช่น	-รวมตัวอย่าง	รวมตัวอย่าง	yes หรือ no

การบริจาค

กระตือรือร้นที่จะเพิ่ม Kirimase? ยินดีต้อนรับการมีส่วนร่วมรายงานข้อผิดพลาดและคำขอคุณสมบัติเสมอ อย่าลังเลที่จะเปิดปัญหาหรือส่งคำขอดึง

เพื่อทำงานในพื้นที่:

pnpm i
pnpm run dev

npm install -g . (in a second terminal - this will then make kirimase available across your machine using " kirimase *command* " )

ใบอนุญาต

มิกซ์