kirimase

Catatan

Catatan: Hanya bug kritis yang sedang ditangani sekarang karena kami merencanakan penulisan ulang lengkap dalam waktu dekat!

Kirimase

Kirimase adalah alat baris perintah untuk membangun full-stack next.js Apps lebih cepat . Ini superharges alur kerja pengembangan Anda, memungkinkan Anda untuk dengan cepat mengintegrasikan paket dan perancah sumber daya untuk aplikasi Anda dengan praktik terbaik dalam pikiran.

Tonton demo terbaru di sini

Lihat tutorial resmi di sini

Fitur

1. Inisialisasi dan Konfigurasi : Dengan cepat menambah dan mengatur paket penting untuk memulai proyek berikutnya.js Anda.
2. Pembuatan kode : Model, tampilan, dan pengontrol perancah langsung dari CLI.

Awal yang cepat

Instal Kirimase Cli secara global:

npm install -g kirimase

Jika Anda belum memiliki aplikasi NextJS, jalankan create-next-app dengan manajer paket pilihan Anda.

Kemudian jalankan perintah berikut dalam direktori proyek Anda:

kirimase init

Catatan: Kirimase tidak kompatibel dengan direktori halaman.

Perintah

Jalankan perintah ini di dalam direktori aplikasi NextJS Anda:

1. kirimase add

Menginisialisasi dan mengkonfigurasi paket berikut untuk proyek Next.js Anda, dikategorikan ke dalam:

Orm

Gerimis-an

• Berdasarkan jenis database yang Anda pilih (PostgreSQL, MySQL, SQLITE), Kirimase mengatur file yang diperlukan untuk gerimis-an, gerimis-zod untuk validasi dan dan gerimis-kit untuk mengelola migrasi.
• Script ditambahkan secara otomatis ke package.json untuk segera menggunakan gerimis-kit.

Prisma

• Kirimase mengatur file yang diperlukan untuk prisma dengan Zod-Prisma untuk validasi.

---

Otentikasi

Auth.js

• Menghasilkan file untuk auth.js (next-auth), termasuk adaptor gerimis terbaru. (Untuk Planetscale, referensi dikecualikan karena tidak mendukung kunci asing).
• Menghasilkan komponen masuk generik untuk segera digunakan dalam proyek Next.js Anda.
• Membungkus tata letak root dengan penyedia auth dan menghasilkan utilitas untuk cek auth dan mengarahkan kembali rute berikutnya.js Anda.

Staf

• Menghasilkan file untuk Petugas termasuk semua konfigurasi yang diperlukan.
• Membungkus tata letak root dengan penyedia auth dan menghasilkan utilitas untuk cek auth dan mengarahkan kembali rute berikutnya.js Anda.

Lucia

• Menghasilkan file untuk Lucia termasuk semua konfigurasi yang diperlukan.
• Menghasilkan rute UI dan API untuk masuk dan mendaftar

Kinde

• Menghasilkan file untuk Kinde termasuk semua konfigurasi yang diperlukan.
• Menghasilkan komponen masuk dan rute handler

---

Lainnya

trpc

• Menghasilkan file untuk mengonfigurasi TRPC dengan router aplikasi.
• Menyediakan TRPC sisi klien dan konfigurasi sisi server Scaffolds menggunakan pola server-invoker eksperimental.
• Membungkus tata letak root di penyedia TRPC.

Shadcn-ui

• Menginstal dan mengkonfigurasi shadcn-ui termasuk komponen tombol dan roti panggang.
• Menyisipkan penyedia bersulang ( <Toaster /> ) ke tata letak root untuk pemberitahuan roti bakar instan di aplikasi berikutnya.js Anda.

Garis

• Menginstal dan mengkonfigurasi stripe di dalam proyek Next.js Anda sehingga Anda dapat mulai menerima pembayaran berlangganan.

Ulang

• Menginstal dan mengkonfigurasi ulang

Kirimase juga menambahkan kunci yang relevan ke .env Anda yang Anda perlukan untuk memberikan nilai.

2. kirimase generate

Mirip dengan rails scaffold tetapi untuk selanjutnya.js:

Kirimase menghasilkan:

A) Model:

• Menghasilkan skema gerimis dengan jenis kolom berdasarkan rasa SQL dan penyedia database Anda.
• Menggunakan gerimis-zod untuk menghasilkan skema zod untuk validasi frontend dan backend.
• Menghasilkan kueri dan mutasi untuk operasi CRUD, diketik sepenuhnya dan dioptimalkan untuk dikonsumsi melalui front-end berikutnya.

b) Pengontrol:

• Memberi Anda opsi untuk perancah TRPC, tindakan server, dan/atau rute API.
• Menggunakan skema zod dari model untuk validasi permintaan.
• Termasuk penanganan kesalahan bawaan untuk rute API dan penilaian otomatis rute TRPC ke router root.

c) Tampilan:

• Tampilan perancah menggunakan shadcn-ui untuk mengaktifkan operasi crud langsung (termasuk bidang tertentu untuk menambahkan hubungan dan datePicker untuk tanggal).
• Opsi untuk menggunakan bentuk react hook dengan TRPC atau reaksi polos (useOptimistic dan usevalidated bentuk kait)

Jalankan dalam mode non-interaktif

Pada v0.0.23, Anda dapat menjalankan kirimase init dan kirimase add sepenuhnya melalui baris perintah sebagai berikut:

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

Memerintah	Bendera pendek	Opsi panjang	Keterangan	Argumen
init	-	-	inisialisasi dan konfigurasikan kirimase	-
-	-H	--Less-head	diinisialisasi tanpa UI	yes atau no
-	-sf	--src-folder	Gunakan folder SRC	yes atau no
-	-pm	--package-manager	Manajer Paket	<pm>
-	-cl	-komponen-lib	Perpustakaan Komponen	<component-lib>
-	-Hai	--Form	orm	<orm>
-	-db	--db	database ("pg", "mysql", "sqlite")	<db>
-	-dbp	--db-penyedia	Penyedia database - penting jika menggunakan gerimis	<dbp>
-	-A	--auth	auth	<auth>
-	-ap	--Auth-providers	Penyedia AUTH (jika menggunakan Next-auth)	<providers>
-	-mp	--MISC-PACKAGES	paket ("trpc", "shadcn-ui", "resend")	<packages>
-	-yaitu	--Menakan contoh	Sertakan contoh	yes atau no

Berkontribusi

Tertarik untuk meningkatkan kirimase? Kontribusi, laporan bug, dan permintaan fitur selalu diterima. Jangan ragu untuk membuka masalah atau mengirimkan permintaan tarik.

Untuk berjalan secara lokal:

pnpm i
pnpm run dev

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

Lisensi

Mit