Skip to main content
Esta guía te lleva desde cero hasta tener el servidor de desarrollo de Comfaca Créditos en Línea corriendo en tu máquina local. Al finalizar, tendrás la aplicación completa disponible en http://localhost:4000 con base de datos migrada, datos iniciales cargados y hot-reload activo para comenzar a desarrollar.

Requisitos Previos

Asegúrate de tener instaladas las siguientes herramientas antes de continuar:
  • Node.js >= 20.x — Descargar Node.js
  • pnpm >= 10.x — instala con npm install -g pnpm o consulta pnpm.io
  • MariaDB >= 10.6 o MySQL >= 8.0 con una base de datos creada y credenciales disponibles

Instalación

1

Clonar el repositorio

Clona el repositorio y accede al directorio del proyecto:
2

Instalar dependencias

Instala todas las dependencias del proyecto usando pnpm:
pnpm utiliza un almacén de paquetes compartido que acelera las instalaciones y ahorra espacio en disco. El archivo pnpm-lock.yaml garantiza versiones reproducibles.
3

Configurar variables de entorno

Copia la plantilla de variables de entorno y completa los valores de tu entorno local:
Edita .env con tus datos reales. Como mínimo debes configurar la cadena de conexión a la base de datos, el secreto JWT y la sesión:
Nunca confirmes el archivo .env en el repositorio. Contiene credenciales sensibles. El archivo .env.template (sin valores) es el que debe mantenerse versionado.
4

Generar cliente Prisma

Genera el cliente de Prisma a partir del esquema definido en prisma/schema.prisma:
Este paso debe repetirse cada vez que modifiques el esquema de Prisma.
5

Ejecutar migraciones

Aplica todas las migraciones pendientes sobre la base de datos configurada en DATABASE_URL:
Prisma creará las tablas y relaciones definidas en el esquema. Si es la primera vez, aplicará todas las migraciones históricas en orden.
6

Cargar datos iniciales

Ejecuta los seeders para poblar la base de datos con los datos iniciales necesarios (roles, líneas de crédito, convenios base, usuario administrador, etc.):
7

Iniciar servidor de desarrollo

Levanta el servidor de desarrollo con hot-reload:
Nuxt compilará la aplicación y arrancará el servidor. Verás en la consola la URL local donde está disponible.

Verificar Instalación

Por defecto, la aplicación corre en el puerto definido por NUXT_PORT en tu .env. La plantilla establece:
Abre tu navegador en http://localhost:4000. Deberías ver:
  • Página de inicio pública con el carrusel hero de Comfaca, la sección de proceso de solicitud y los testimonios.
  • Enlace de ingreso disponible en la barra de navegación para acceder como afiliado o administrador.
  • Sin errores de consola relacionados con la base de datos ni con las variables de entorno.
Si el puerto 4000 está ocupado, cambia el valor de NUXT_PORT en .env y reinicia el servidor. Nuxt también mostrará la URL exacta en los logs de arranque.

Scripts Disponibles

Todos los scripts se ejecutan con pnpm <script>. A continuación, el listado completo definido en package.json:
Para el flujo de desarrollo habitual, los scripts más usados son pnpm dev, pnpm lint, pnpm typecheck y pnpm test. Ejecuta pnpm db:migrate cada vez que incorpores cambios al esquema de Prisma.

Configurar Variables de Entorno

Descripción completa de todas las variables de entorno: base de datos, APIs externas, correo, SFTP y seguridad.

Configurar Base de Datos

Guía para crear la base de datos MariaDB, gestionar migraciones con Prisma y ejecutar los seeders iniciales.