Instalación y Configuración Local - bootcamp-uchile-2026/grupo-2-backend GitHub Wiki

Instalación y Configuración Local

Esta página presenta una guía reproducible para preparar un entorno de desarrollo de BuenOrigen Backend, basado en NestJS y TypeScript. Los comandos genéricos aquí incluidos deben contrastarse con package.json, la configuración y el README de la versión actual de develop antes de tratarlos como requisitos definitivos.

Requisitos

  • Git.
  • Node.js y npm compatibles con el proyecto.
  • Acceso autorizado al repositorio privado bootcamp-uchile-2026/grupo-2-backend.
  • Editor de código y terminal.

Versión de Node.js: pendiente de verificar en .nvmrc, package.json (engines) o la configuración del equipo. No se fija arbitrariamente una versión en esta guía.

Obtener el repositorio

git clone https://github.com/bootcamp-uchile-2026/grupo-2-backend.git
cd grupo-2-backend
git switch develop
git pull --ff-only origin develop

El repositorio es privado: la clonación requiere permisos y autenticación. Si ya existe una copia local, no volver a clonar: actualizar develop.

Instalar dependencias

En el directorio raíz:

npm ci

npm ci requiere un package-lock.json compatible. Si el equipo ha acordado otro mecanismo de instalación, respetar el README y los archivos de bloqueo vigentes.

Variables de entorno

Comprobar si el proyecto contiene .env.example u otro archivo de ejemplo y seguir sus instrucciones. No copiar credenciales reales a la Wiki ni subir .env al repositorio.

No se confirman aquí nombres de variables, credenciales, puertos personalizados ni cadenas de conexión, porque no se verificaron contra la configuración final de develop.

En particular, cualquier configuración de base de datos, contenedores o servicios externos debe derivarse del código efectivamente integrado y de la documentación del equipo responsable.

Ejecutar el proyecto

Para un proyecto NestJS estándar, el script de desarrollo suele ser:

npm run start:dev

Verificar su existencia en package.json. Una vez iniciado, consultar los mensajes de la terminal para confirmar puerto y dirección reales.

Swagger / OpenAPI

Según los antecedentes del proyecto, la interfaz de Swagger se ha documentado en la ruta:

/api

Con el puerto local 3000 como ejemplo:

http://localhost:3000/api

Esta URL es referencial hasta verificar la configuración efectiva de main.ts, el puerto y las variables de entorno.

Validaciones de desarrollo

Ejecutar los scripts definidos por el proyecto. En un entorno NestJS habitual:

npm run build
npm test

No se presupone que el repositorio tenga todos los scripts de lint, tests e2e o cobertura: consultar package.json. Registrar la salida de los comandos ante errores.

Prueba funcional mínima

  1. Confirmar que la aplicación inicia sin errores.
  2. Abrir Swagger si está habilitado.
  3. Comprobar las rutas públicas documentadas en Endpoints.
  4. Verificar parámetros, códigos de respuesta y DTO conforme a DTOs.
  5. No asumir la existencia de rutas de escritura, autenticación o persistencia que no figuren en el código vigente.

Diagnóstico habitual

Situación Comprobación sugerida
Fallo al instalar dependencias Revisar versión de Node/npm, lockfile y conectividad al registro npm
npm run ... falla por script inexistente Consultar scripts en package.json
Puerto ocupado Revisar proceso que usa el puerto definido por la aplicación
Swagger no abre Verificar main.ts, montaje de Swagger y ruta configurada
Error de variable de entorno Comparar configuración real con ejemplo seguro, sin exponer secretos
Respuesta inesperada de un endpoint Revisar Endpoints, DTOs y la versión de rama ejecutada

Información aún por verificar para convertir esta guía en definitiva

  • Versión mínima u oficial de Node.js/npm.
  • Scripts exactos de package.json.
  • Variables de entorno requeridas y archivo de ejemplo.
  • Puerto y prefijos globales en main.ts.
  • Necesidad o no de servicios externos para levantar el backend.

Esta página describe una instalación local orientativa con pasos estándar. No afirma que exista una base de datos, un proveedor de despliegue o una configuración Docker ya implementados.

Referencias