Rechercher

Rechercher dans Kavel...

Kavel
Menu de documentation

Démarrage rapide

Générez une nouvelle application, exécutez-la en local et voyez l'API et l'application web dialoguer en quelques minutes.

Prérequis

  • Bun 1.3 ou plus récent, le gestionnaire de paquets et le runtime
  • Un compte Cloudflare (l'offre gratuite suffit pour commencer)

1. Créer votre application

Lancez le scaffolder et choisissez les modules souhaités lorsqu'ils sont proposés :

bash
bun create kavel@latest my-app

La CLI clone le modèle, n'assemble que les modules sélectionnés, installe les dépendances, prépare un .dev.vars local, génère les types et initialise un dépôt git.

2. Démarrer les serveurs de dev

bash
cd my-app
bun dev

Turbo démarre les deux applications en parallèle : l'API sur localhost:8787 et l'application web sur localhost:3000. Ouvrez l'application web et c'est parti.

Astuce

En développement, l'API expose une référence interactive sur /rpc/docs. Elle est désactivée automatiquement lorsque ENVIRONMENT vaut production.

3. Configurer la base de données

Si vous avez choisi un module qui utilise la base de données (auth, e-mail ou paiements), générez et appliquez les migrations locales :

bash
cd apps/api
bun db:generate
bun db:migrate

db:generate transforme votre schéma Drizzle en migrations SQL ; db:migrate les applique à la base D1 locale. N'écrivez jamais les migrations à la main, modifiez le schéma et régénérez.

4. Renseigner les secrets au fur et à mesure

Les modules fonctionnent avec des no-ops sensés jusqu'à ce que vous ajoutiez des identifiants, vous pouvez vous inscrire et explorer avant de configurer quoi que ce soit. Quand vous êtes prêt, ouvrez apps/api/.dev.vars et renseignez les clés des services utilisés. Voir Configuration pour la liste complète.

Étapes suivantes