Buscar

Buscar en Kavel...

Kavel
Menú de documentación

Inicio rápido

Genera una app nueva, ejecútala en local y observa cómo la API y la app web se comunican en un par de minutos.

Requisitos

  • Bun 1.3 o posterior, el gestor de paquetes y runtime
  • Una cuenta de Cloudflare (el plan gratuito basta para empezar)

1. Crea tu app

Ejecuta el scaffolder y elige los módulos que quieras cuando se te pregunte:

bash
bun create kavel@latest my-app

La CLI clona la plantilla, ensambla solo los módulos seleccionados, instala dependencias, prepara un .dev.vars local, genera tipos e inicializa un repositorio git.

2. Arranca los servidores de desarrollo

bash
cd my-app
bun dev

Turbo arranca ambas apps en paralelo: la API en localhost:8787 y la app web en localhost:3000. Abre la app web y ya está corriendo.

Consejo

En desarrollo, la API sirve una referencia interactiva en /rpc/docs. Se desactiva automáticamente cuando ENVIRONMENT es production.

3. Configura la base de datos

Si elegiste un módulo que usa la base de datos (auth, correo o pagos), genera y aplica las migraciones locales:

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

db:generate convierte tu esquema de Drizzle en migraciones SQL; db:migrate las aplica a la base D1 local. Nunca escribas migraciones a mano, edita el esquema y regenera.

4. Rellena los secretos sobre la marcha

Los módulos funcionan con no-ops sensatos hasta que añades credenciales, puedes registrarte y explorar antes de configurar nada. Cuando estés listo, abre apps/api/.dev.vars y rellena las claves de los servicios que uses. Consulta Configuración para la lista completa.

Próximos pasos