Saltar al contenido principal
Ya seas un desarrollador experimentado o estés comenzando, encontrarás instrucciones claras y prácticas para que todo funcione sin problemas.
ImportanteEsta es la documentación para una versión obsoleta de Midaz. Aunque todavía está operativa y recibe actualizaciones de seguridad críticas, ya no se mantiene activamente ni se mejora.Para la mejor experiencia y soporte continuo, cambia a la versión más reciente.

​
Requisitos del sistema

  • Sistema operativo:
    • Windows: Windows 10 versión 2004 o posterior (Build 19041+)
    • macOS: Versión actual o las dos anteriores
    • Linux: Ubuntu o Debian recomendado
  • RAM: Al menos 8 GB
  • Espacio en disco: 20 GB libres
  • Internet: Conexión estable
  • Navegador: Chrome, Firefox o equivalente

​
Herramientas requeridas

​
Autenticación

La versión comunitaria de Midaz no tiene autenticación incorporada. Las APIs son de acceso público. Si necesitas autenticación, usa el plugin Access Manager (solo Enterprise). Contacta a nuestro equipo para saber más.
ImportanteSin autenticación, recomendamos encarecidamente mantener Midaz en una red privada segura.

​
¿Ya usas repositorios separados?

Si has instalado Midaz y la Console desde repositorios separados, recomendamos migrar a la configuración de monorepo. El repositorio independiente de Console ha sido obsoleto, y todo el desarrollo futuro ocurrirá en la estructura unificada.
ImportanteEl repositorio independiente de Console ya no se mantiene. Para estar actualizado, cambia al monorepo unificado.
1
Abre tu terminal y ve al directorio midaz.
2
Descarga la última versión del repositorio.Opción 1 – Ejecutar la Console vía Docker (recomendado)
make up
Luego ve a http://localhost:8081 en tu navegador.Opción 2 – Ejecutar la Console manualmente usando Node.js
cd midaz/components/console
npm install
npm run set-local-env
npm run dev
Accede a la Console en: http://localhost:8081
Para ejecutar la Console manualmente, asegúrate de que solo Midaz esté ejecutándose en Docker. Detén el contenedor de Console para evitar conflictos de puertos.

​
Configuración en Windows: Instalar WSL

Si estás usando Windows, debes instalar WSL (Windows Subsystem for Linux) y ejecutar Midaz a través de él.
1
Abre PowerShell como administrador.
2

Ejecuta

wsl --install
3

Reinicia si se solicita

Reinicia si se solicita.
TipDespués de instalar WSL, abre Ubuntu vía el menú Inicio.

​
Instalar Midaz (Monorepo)

​
Paso 1 – Abre tu terminal

  • macOS/Linux: Terminal
  • Windows: Ubuntu (WSL)
ImportanteSi usas Windows, ejecuta todos los comandos dentro de Ubuntu (WSL). ¿No estás familiarizado con terminales? Consulta esta guía para principiantes.

​
Paso 2 – Instalar make

  • Linux: 
    sudo apt install make
  • macOS: 
    brew install make

​
Paso 3 – Descargar el monorepo de Midaz

1

Elige tu directorio de trabajo

cd ~/Desktop
2

Clona el repositorio

git clone https://github.com/LerianStudio/midaz.git
3

Entra a la carpeta

cd midaz

​
Paso 4 – Configurar variables de entorno

make set-env

​
Paso 5 – Iniciar los servicios

Asegúrate de que Docker esté ejecutándose, luego: 
make up
Todos los servicios, incluida la Console, se iniciarán.

​
Paso 6 – Accede a tu entorno

ImportanteAsegúrate de que las variables de entorno estén configuradas y Docker esté activo antes de acceder a la Console.

​
Desarrollar la Console localmente

Si planeas desarrollar la Console activamente, Docker no es ideal. Ejecútala localmente para evitar problemas de vinculación de puertos. Para hacerlo, sigue estos pasos:
1

Detener el contenedor de Console

docker stop midaz-console
2

Ve a la carpeta de Console

cd components/console
3

Instalar dependencias

npm install
4

Configurar entorno

npm run set-local-env
5

Iniciar modo dev

npm run dev
NotaLa primera carga puede tomar unos minutos mientras se compilan las páginas.

​
Probar la API

  • Ve a midaz/postman
  • Importa MIDAZ.postman_collection.json en Postman
  • Explora los endpoints disponibles
Tip¿Listo para construir? Comienza con nuestra Guía de inicio rápido.

​
Comunidad, soporte y contribución

¿Listo para contribuir? Consulta nuestra Guía de contribución.
Tip¿Necesitas ayuda experta? Habla con nuestro equipo para soporte personalizado.

​
Licencia

Midaz es open-source, licenciado bajo la Licencia Apache 2.0.