Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/elegroag/nuxt-credito-caja/llms.txt

Use this file to discover all available pages before exploring further.

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:
git clone <url-del-repositorio>
cd nuxt-creditos
2

Instalar dependencias

Instala todas las dependencias del proyecto usando pnpm:
pnpm install
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:
cp .env.template .env
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:
# Base de datos
DATABASE_URL="mysql://usuario:contraseña@localhost:3306/comfaca_creditos"

# Servidor
NUXT_PORT=4000
NUXT_HOST="localhost"
NUXT_JWT_SECRET="un-secreto-largo-y-aleatorio"
NUXT_SESSION_PASSWORD="otra-cadena-aleatoria-de-al-menos-32-chars"

# Entorno de ejecución
NODE_ENV=development
STAGE=dev
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:
pnpm db:generate
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:
pnpm db:migrate
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.):
pnpm db:seed
7

Iniciar servidor de desarrollo

Levanta el servidor de desarrollo con hot-reload:
pnpm dev
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: 
NUXT_PORT=4000
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:
ScriptComando completoDescripción
devnuxt devServidor de desarrollo con hot-reload
buildnuxt buildCompila la aplicación para producción
previewnuxt previewPrevisualiza el build de producción en local
linteslint .Ejecuta ESLint sobre todo el proyecto
typechecknuxt typecheckVerifica tipos TypeScript sin emitir archivos
db:generateprisma generateGenera el cliente Prisma desde el esquema
db:pushprisma db pushSincroniza el esquema con la BD sin migraciones
db:pullprisma db pullIntrospección: genera el esquema desde la BD existente
db:migrateprisma migrate dev --schema=./prisma/schema.prismaCrea y aplica migraciones en modo desarrollo
db:resetprisma migrate reset --schema=./prisma/schema.prismaReinicia la BD y vuelve a aplicar todas las migraciones
db:seedprisma db seedEjecuta los seeders de datos iniciales
testvitestEjecuta todos los tests en modo watch
test:uivitest --uiAbre la interfaz visual de Vitest en el navegador
test:unitvitest runEjecuta los tests unitarios una sola vez
test:unit:servervitest run --project server-unitEjecuta únicamente los tests unitarios del servidor
test:unit:clientvitest run --project client-unitEjecuta únicamente los tests unitarios del cliente
test:integrationvitest run --project integrationEjecuta las pruebas de integración de la API
test:e2eplaywright testEjecuta las pruebas end-to-end con Playwright
test:e2e:uiplaywright test --uiAbre la interfaz visual de Playwright en el navegador
test:coveragevitest run --coverageGenera reporte de cobertura de código
nohup:firmastsx server/nohup/app.tsInicia el proceso de monitoreo de firmas en primer plano
nohup:firmas:daemonnohup pnpm nohup:firmas >> storage/logs/nohup-firmas.log 2>&1 &Inicia el monitor de firmas como proceso en segundo plano (daemon)
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.

Build docs developers (and LLMs) love

Get started for freeTalk to us