Skip to content

Instalación ​

Requisitos previos ​

HerramientaVersión mínimaNotas
Node.js>=22 <25Usar nvm; .nvmrc incluido en el repo
npm10+Incluido con Node 22
GitCualquiera reciente—
Cuenta Supabase—Necesaria para la base de datos

1. Clonar el repositorio ​

bash
git clone https://github.com/anomalyco/kaleo.git
cd kaleo

2. Instalar dependencias ​

El proyecto usa npm workspaces con Turborepo. Instala todo desde la raíz:

bash
# Instala dependencias de todos los workspaces
npm install --prefix backend
npm install --prefix frontend
npm install --prefix docs

O en un solo comando:

bash
npm run install:all

3. Configurar variables de entorno ​

Backend ​

bash
cp backend/.env.example backend/.env.development

Edita backend/.env.development con tus valores. Las variables obligatorias son:

bash
DATABASE_URL="postgresql://postgres.<ref>:<password>@aws-0-<region>.pooler.supabase.com:6543/postgres"
JWT_SECRET=<string-aleatorio-largo>
CORS_ORIGIN=http://localhost:5173
FRONTEND_URL=http://localhost:5173
NODE_ENV=development

Ver la guía completa de variables de entorno para todas las opciones.

Frontend ​

bash
cp frontend/.env.example frontend/.env.development

El frontend solo necesita:

bash
VITE_API_URL=http://localhost:3000/api

4. Configurar la base de datos ​

Kaleo usa Supabase como proveedor PostgreSQL. Necesitas crear dos proyectos:

ProyectoUsoRegión recomendada
kaleo-devDesarrollo diarioca-central-1
kaleo-prodProducciónus-east-2

Aplicar migraciones ​

Las migraciones son archivos SQL en backend/src/migrations/. Aplícalas en orden en el SQL Editor de Supabase:

000 → 002 → 003 → 004 → 005 → 006 → 007 → 008 → 009 → 010
→ 011 → 012 → 013 → 014 → 015 → 016 → 017

TIP

La migración 000 es re-ejecutable. Incluye el esquema completo. Puedes usarla para crear el schema desde cero en una base de datos vacía.

Verificar migraciones aplicadas ​

sql
SELECT version FROM schema_migrations ORDER BY version;

5. Ejecutar en desarrollo ​

bash
# Levanta backend (puerto 3000) + frontend (puerto 5173) simultáneamente
npm run dev

O por separado:

bash
# Solo backend
npm run dev --prefix backend

# Solo frontend
npm run dev --prefix frontend

6. Verificar que funciona ​

ServicioURLDescripción
Frontendhttp://localhost:5173App Vue 3
Backendhttp://localhost:3000NestJS API
Health checkhttp://localhost:3000/healthEstado del servidor y BD
Swagger UIhttp://localhost:3000/api/docsRequiere SWAGGER_ENABLED=true

Scripts útiles ​

bash
# Correr tests (backend + frontend)
npm test

# TypeCheck estricto
npm run typecheck

# Linting
npm run lint

# Build de producción
npm run build

# Documentación (este sitio)
npm run docs:dev

Primer usuario ​

Una vez que la base de datos está lista, crea el primer usuario Owner:

bash
npm run seed:owner --prefix backend -- development tu@email.com "Tu Nombre" "Nombre Empresa"

WARNING

Este script solo funciona en bases de datos vacías (sin usuarios previos). Úsalo únicamente en development.

Documentación de Kaleo — plataforma SaaS multi-tenant