kirimase

Notiz

Hinweis: Im Moment werden nur kritische Fehler angesprochen, da wir in naher Zukunft ein vollständiges Umschreiben planen!

Kirimase

Kirimase ist ein Befehlszeilen-Tool zum Erstellen von Full-Stack Next.js-Apps schneller . Es wird Ihren Entwicklungsworkflow aufgeladen, sodass Sie Pakete und Gerüstressourcen für Ihre Anwendung mit den besten Praktiken schnell integrieren können.

Sehen Sie sich hier die neueste Demo an

Schauen Sie sich das offizielle Tutorial hier an

Merkmale

1. Initialisierung und Konfiguration : Fügen Sie schnell wichtige Pakete hinzu und richten Sie schnell ein, um Ihr nächstes.js-Projekt zu starten.
2. Codegenerierung : Gerüstmodelle, Ansichten und Controller direkt aus der CLI.

Schneller Start

Installieren Sie Kirimase CLI weltweit:

npm install -g kirimase

Wenn Sie noch keine NextJS-App haben, führen Sie Create-Next-App mit Ihrem bevorzugten Paketmanager aus.

Führen Sie dann den folgenden Befehl im Verzeichnis Ihres Projekts aus:

kirimase init

Hinweis: Kirimase ist nicht mit dem Verzeichnis der Seiten kompatibel.

Befehle

Führen Sie diese Befehle im Verzeichnis Ihrer nächsten Js -App aus:

1. kirimase add

Initialisiert und konfiguriert die folgenden Pakete für Ihr nächstes.js -Projekt, kategorisiert in:

Orm

Nieselregen

• Basierend auf Ihrem ausgewählten Datenbanktyp (PostgreSQL, MySQL, SQLite) legt Kirimase die erforderlichen Dateien für Nieselregen, Nieselregen für Validierungen und Dreckle-Kit zur Verwaltung von Migrationen ein.
• Skripte sind automatisch an package.json für den sofortigen Gebrauch von Dreckle-Kit.

Prisma

• Kirimase richtet die erforderlichen Dateien für Prisma mit Zod-Prisma für Validierungen ein.

---

Authentifizierung

Auth.js

• Generiert Dateien für Auth.js (Next-Auth), einschließlich des neuesten Niedrigungsadapters. (Für Planetscale werden Referenzen ausgeschlossen, da es keine ausländischen Schlüssel unterstützt.)
• Generiert eine generische Anmeldekomponente für die sofortige Verwendung innerhalb Ihres nächsten.js-Projekts.
• Wickelt das Root -Layout mit dem Auth -Anbieter und generiert Dienstprogramme für Auth -Checks und leitet in Ihren nächsten Routen.

Sachbearbeiter

• Generiert Dateien für den Angestellten, einschließlich aller erforderlichen Konfiguration.
• Wickelt das Root -Layout mit dem Auth -Anbieter und generiert Dienstprogramme für Auth -Checks und leitet in Ihren nächsten Routen.

Lucia

• Generiert Dateien für Lucia einschließlich aller erforderlichen Konfigurationen.
• Generiert UI- und API-Routen für Anmeldung und Anmeldung

Freundlich

• Generiert Dateien für die Art, einschließlich aller erforderlichen Konfigurationen.
• Generiert Anzeichen in Komponenten- und Routenhandler

---

Andere

TRPC

• Generiert Dateien, um TRPC mit dem App -Router zu konfigurieren.
• Bietet clientseitige TRPC- und Gerüst-Server-Side-Konfiguration mithilfe des experimentellen Server-Invoker-Musters.
• Wickelt das Root -Layout in den TRPC -Anbieter.

Shadcn-ui

• Installiert und konfiguriert Shadcn-UI einschließlich Knopf- und Toastkomponenten.
• Fügt den Toast-Provider ( <Toaster /> ) in das Stammlayout für sofortige Toastbenachrichtigungen in Ihrer nächsten.js-App ein.

Streifen

• Installiert und konfiguriert Stripe in Ihrem nächsten.js -Projekt, damit Sie Abonnementzahlungen akzeptieren können.

Wiederholen

• Installiert und konfiguriert das Wiedervergeben

Kirimase fügt Ihrem .env auch relevante Schlüssel hinzu, für die Sie Werte bereitstellen müssen.

2. kirimase generate

Ähnlich rails scaffold aber für Next.js:

Kirimase erzeugt:

a) Modell:

• Erzeugt ein Nieselregenschema mit Spaltentypen basierend auf Ihrem SQL -Aroma- und Datenbankanbieter.
• Verwendet Dreckle-Zod, um ZOD-Schemas für Frontend- und Backend-Validierung zu generieren.
• Erzeugt Abfragen und Mutationen für CRUD-Operationen, die vollständig typisiert und für den Konsum über ein nächstes.js Front-End optimiert werden.

b) Controller:

• Sie geben Ihnen eine Option, um TRPC, Serveraktionen und/oder API -Routen zu sammeln.
• Verwendet ZOD -Schemata aus Modellen zur Anfragevalidierung.
• Beinhaltet ein integriertes Fehlerbehebung für API-Routen und automatische Angaben von TRPC-Routen zum Stammrouter.

c) Ansichten:

• Gerüstansichten mit Shadcn-UI, um sofortige CRUD-Operationen zu ermöglichen (einschließlich ausgewählter Felder zum Hinzufügen von Beziehungen und Datepickern für Daten).
• Option zur Verwendung entweder React -Hakenform mit TRPC oder einfachem Reakt (useoptimistisch und useValidated Form Haken)

Im nicht interaktiven Modus ausführen

Ab V0.0.23 können Sie kirimase init und 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

Befehl	Kurze Flagge	Lange Option	Beschreibung	Argument
init	- -	- -	initialisieren und konfigurieren Sie Kirimase	- -
- -	-H	--kopflos	initialisieren ohne UI	yes oder no
- -	-sf	-Src-Folder	Verwenden Sie einen SRC -Ordner	yes oder no
- -	-pm	-Package-Manager	Paketmanager	<pm>
- -	-cl	-komponent-lib	Komponentenbibliothek	<component-lib>
- -	-O	-Orm	Orm	<orm>
- -	-db	-DB	Datenbank ("PG", "MySQL", "SQLite")	<db>
- -	-dbp	-DB-Provider	Datenbankanbieter - wichtig, wenn Sie Nieselregen verwenden	<dbp>
- -	-A	--Auth	Auth	<auth>
- -	-ap	--Auth-Providers	AUTH-Anbieter (bei Verwendung der nächsten Auth)	<providers>
- -	-mp	-Misc-Packages	Pakete ("TRPC", "Shadcn-ui", "Reend")	<packages>
- -	-ie	-Inklude-Beispiel	Beispiel einschließen	yes oder no

Beitragen

Sie möchten Kirimase verbessern? Beiträge, Fehlerberichte und Feature -Anfragen sind immer willkommen. Fühlen Sie sich frei, ein Problem zu eröffnen oder eine Pull -Anfrage einzureichen.

Lokal laufen:

pnpm i
pnpm run dev

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

Lizenz

MIT