Note
Remarque: seuls les bogues critiques sont traités en ce moment car nous prévoyons une réécriture complète dans un avenir très proche!
Kirimase
Kirimase est un outil de ligne de commande pour construire plus rapidement les applications Full-Stack.JS . Il suralimente votre flux de travail de développement, vous permettant d'intégrer rapidement des packages et d'échafaudage des ressources pour votre application en pensant aux meilleures pratiques.
Regardez la démo la plus récente ici
Consultez le tutoriel officiel ici
Caractéristiques
- Initialisation et configuration : ajoutez et configurez rapidement les packages essentiels pour relancer votre projet Next.js.
- Génération de code : modèles d'échafaudage, vues et contrôleurs directement à partir de la CLI.
Démarrage rapide
Installez Kirimase CLI à l'échelle mondiale:
Si vous n'avez pas déjà d'application NextJS, exécutez Create-Next-App avec votre gestionnaire de packages préféré.
Ensuite, exécutez la commande suivante dans le répertoire de votre projet:
Remarque: Kirimase n'est pas compatible avec le répertoire des pages.
Commandes
Exécutez ces commandes dans le répertoire de votre application NextJS:
1. kirimase add
Initialise et configure les packages suivants pour votre projet Next.js, classé en:
Orm
Terzzle
- Sur la base de votre type de base de données choisi (PostgreSQL, MySQL, SQLite), Kirimase configure les fichiers requis pour la bouffine de bruine, la bruine-zod pour les validations et et le kit arrosé pour gérer les migrations.
- Les scripts sont automatiquement ajoutés à
package.json pour une utilisation immédiate de la bouffée de bruine.
Prisma
- Kirimase configure les fichiers requis pour PRISMA avec ZOD-PRISMA pour les validations.
Authentification
Auth.js
- Génère des fichiers pour Auth.js (Next-Auth), y compris le dernier adaptateur d'arrosage. (Pour l'échelle de planètes, les références sont exclues car elles ne soutiennent pas les clés étrangères).
- Génère un composant de connexion générique pour une utilisation immédiate dans votre projet Next.js.
- Enveloppe la disposition root avec le fournisseur d'autheurs et génère des utilitaires pour les vérifications et redirigez les autorités dans vos routes suivantes.
Greffier
- Génère des fichiers pour le commis, y compris toute la configuration nécessaire.
- Enveloppe la disposition root avec le fournisseur d'autheurs et génère des utilitaires pour les vérifications et redirigez les autorités dans vos routes suivantes.
Lucia
- Génère des fichiers pour Lucia, y compris toute la configuration nécessaire.
- Génère des routes d'interface utilisateur et d'API pour la connexion et l'inscription
Kider
- Génère des fichiers pour KINDE, y compris toute la configuration nécessaire.
- Génère la connexion en composante et gestionnaire de route
Autre
trpc
- Génère des fichiers pour configurer TRPC avec le routeur de l'application.
- Fournit la configuration du côté du client côté client et des échafaudages à l'aide du modèle expérimental de serveur-invoker.
- Enveloppe la disposition racine dans le fournisseur TRPC.
Shadcn-ui
- Installe et configure Shadcn-UI, y compris les composants du bouton et du toast.
- Insère le Toast-Provider (
<Toaster /> ) à la disposition racine pour les notifications de toast instantanées dans votre application Next.js.
Bande
- Installe et configure Stripe dans votre projet Next.js afin que vous puissiez commencer à accepter les paiements d'abonnement.
Revivre
- Installe et configure le rendement
Kirimase ajoute également des clés pertinentes à votre .env pour lesquelles vous devrez fournir des valeurs.
2. kirimase generate
Akin to rails scaffold mais pour next.js:
Kirimase génère:
a) Modèle:
- Génère un schéma de filet avec des types de colonnes basés sur votre fournisseur de saveurs et de base de données SQL.
- Utilise du slizzle-zod pour générer des schémas ZOD pour la validation frontale et backend.
- Génère des requêtes et des mutations pour les opérations CRUD, entièrement typées et optimisées pour la consommation via un front-end suivant.
b) Contrôleur:
- Vous donne une option pour échafaudager TRPC, les actions du serveur et / ou les routes API.
- Utilise des schémas ZOD à partir de modèles pour la validation de la demande.
- Comprend une gestion des erreurs intégrée pour les routes API et le trafic automatique des routes TRPC vers le routeur racine.
c) Vues:
- Vues d'échafaudages à l'aide de Shadcn-UI pour activer les opérations CRUD immédiates (y compris les champs sélectionnés pour ajouter des relations et des dattepickers pour les dates).
- Option pour utiliser le formulaire de crochet React avec TRPC ou réagir ordinaire (usage et crochets de formulaire usulaires)
Exécuter en mode non interactif
Depuis V0.0.23, vous pouvez exécuter kirimase init et kirimase add entièrement via la ligne de commande comme suit:
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
| Commande | Drapeau court | Longue option | Description | Argument |
|---|
| init | - | - | initialiser et configurer la kirimase | - |
| - | -H | --sans tête | initialiser sans interface utilisateur | yes ou no |
| - | -sf | --src-folder | Utilisez un dossier SRC | yes ou no |
| - | -pm | - Package-Manager | Gestionnaire de packages | <pm> |
| - | -Cl | - composant-lib | bibliothèque de composants | <component-lib> |
| - | -o | - | orm | <orm> |
| - | -db | - db | base de données ("pg", "mysql", "sqlite") | <db> |
| - | -dbp | --db-prodiger | Proviseur de base de données - Important si vous utilisez du bruine | <dbp> |
| - | -un | - Auth | authentification | <auth> |
| - | -Ap | - Auth-Providers | fournisseurs d'authers (si vous utilisez la prochaine AUTH) | <providers> |
| - | -mp | - des packages-mass | packages ("trpc", "shadcn-ui", "resend") | <packages> |
| - | -ie | - inclusion-exemple | inclure l'exemple | yes ou no |
Contributif
Vous souhaitez améliorer la kirimase? Les contributions, les rapports de bogues et les demandes de fonctionnalités sont toujours les bienvenues. N'hésitez pas à ouvrir un problème ou à soumettre une demande de traction.
Pour courir localement:
pnpm i
pnpm run dev
npm install -g . (in a second terminal - this will then make kirimase available across your machine using " kirimase *command* " )
Licence
Mit
