Skip to main content

​
Inicio rápido

Esta guía levanta FactrAPI en un entorno de desarrollo local. Los valores incluidos en Docker Compose son de desarrollo y no se deben reutilizar en producción.

​
Requisitos

  • Node.js 24.x y pnpm 11.x.
  • Docker Desktop o Docker Engine con Docker Compose.
  • Git.

​
Levantar el sistema

Desde la carpeta del repositorio factrApi:
Compose inicia la API, el worker, el scheduler, PostgreSQL y Redis. La primera ejecución construye la imagen y aplica las migraciones. Comprueba las rutas de salud:
La primera ruta confirma que el proceso HTTP responde. La segunda comprueba PostgreSQL, Redis y el almacenamiento configurado.

​
Probar con Postman

Importa la colección postman/FactrAPI-Pruebas.postman_collection.json y, si quieres, el entorno postman/FactrAPI-Local.postman_environment.json. Selecciona el entorno y ejecuta primero las solicitudes de Salud y documentación. Consulta la guía de Postman para configurar una API key de prueba y entender los permisos requeridos. Las solicitudes de la colección son consultas de solo lectura. No crean documentos, no consumen números e-NCF y no envían información a la DGII.

​
Abrir la API y su documentación

Con la API local en marcha:
  • Swagger UI: http://localhost:3000/docs
  • Especificación OpenAPI JSON: http://localhost:3000/docs-json
  • Liveness: http://localhost:3000/health
  • Readiness: http://localhost:3000/ready
En desarrollo, Swagger está habilitado por defecto. En producción necesita OPENAPI_ENABLED=true.

​
Previsualizar la documentación Mintlify

Desde la raíz del repositorio, instala el CLI y ejecuta la vista previa en el puerto 3001, porque la API local usa el 3000:
Abre http://localhost:3001 para revisar las guías del ecosistema antes de publicarlas.

​
Ejecutar procesos en el host

Para desarrollar la API fuera de Docker, levanta solo PostgreSQL y Redis, copia el archivo de entorno de ejemplo y ejecuta el servidor:
Revisa .env.example antes de iniciar. Sus valores son locales y de desarrollo. Para usar S3 local, consulta docs/STORAGE.md en el repositorio de FactrAPI.