Guía de Inicio Rápido

🚀 Guía de Inicio Rápido

Esta guía te guiará paso a paso para clonar, configurar y arrancar el entorno full-stack de Criptofolio en tu máquina local.

📋 Requisitos Previos

Antes de comenzar, asegúrate de contar con las siguientes herramientas instaladas:

Node.js: Versión v20.x o superior (probado y verificado hasta v24.x).
PNPM: Versión v9.x o superior (pnpm -v).
Git: Para el control de versiones.

[!NOTE] Criptofolio funciona sobre el soporte nativo de node:sqlite incorporado en Node.js, lo que elimina dependencias binarias externas para el ledger transaccional.

📥 1. Clonar el Repositorio

Clona el repositorio en tu espacio de trabajo local:

git clone https://github.com/nelomr/criptofolio.git
cd criptofolio

📦 2. Instalar Dependencias del Monorepo

Instala todas las dependencias del espacio de trabajo de PNPM desde la raíz:

pnpm install

[!TIP] Criptofolio utiliza los PNPM Catalogs definidos en pnpm-workspace.yaml. Dependencias compartidas como TypeScript, Zod y Hono comparten versiones idénticas y centralizadas.

⚙️ 3. Configuración de Variables de Entorno

Copia los archivos de ejemplo de entorno para desarrollo local:

# Crear el archivo de entorno en la raíz
cp .env.example .env

# (Opcional) Variables específicas para la aplicación frontend
cp apps/frontend/.env.example apps/frontend/.env

Variables principales por defecto:

Variable	Valor por Defecto	Descripción
`VITE_API_URL`	`http://localhost:3001`	URL donde escucha el backend de Hono
`VITE_APP_LANG`	`es`	Idioma de la interfaz (`es` o `en`)
`PORT`	`3001`	Puerto del servidor HTTP de Hono
`MOCK_MODE`	`false`	En `true`, utiliza una base de datos SQLite en memoria
`CRIPTOFOLIO_DATA_DIR`	Raíz del Workspace	Directorio donde se guardan los archivos `.db` y Parquet

💻 4. Arrancar los Servidores de Desarrollo

Criptofolio ofrece varios comandos de ejecución orquestados por Turborepo:

Opción A: Full-Stack Simultáneo (Recomendada)

Inicia concurrentemente la interfaz Vue 3 (:5173) y el backend Hono (:3001):

pnpm dev:full

Opción B: Solo Frontend

Si deseas trabajar únicamente en la capa visual conectándote a un backend ya en marcha o con mocks:

pnpm dev

Opción C: Solo Backend

Inicia el servidor API de Hono con el ledger SQLite y el motor DuckDB:

pnpm dev:backend

🌐 5. Acceder al Panel de Control

Una vez arrancados los servidores, abre tu navegador y accede a:

👉 http://localhost:5173

El punto de comprobación de salud y las rutas del backend estarán disponibles en:

👉 http://localhost:3001/api/health

🧪 6. Validación de Tests y Tipos

Antes de realizar modificaciones, comprueba que la suite pasa limpiamente:

# Ejecutar tests unitarios y de integración (Vitest)
pnpm test

# Verificación estática de tipos con Vue-TSC
pnpm typecheck

# Análisis estático de código con ESLint
pnpm lint

🧭 Siguientes Pasos

Conoce los detalles de Configuración y Entorno
Entiende la Arquitectura Hexagonal
Descubre el Motor Fiscal FIFO