Saltar al contenido principal

​
Requisitos previos

Asegúrate de tener lo siguiente listo:

​
1. Requisitos del sistema

Tu computadora debe cumplir con estos requisitos mínimos:
  • Sistema operativo:
    • Windows: Windows 10 versión 2004 o posterior (Build 19041 o superior).
    • macOS: Versión actual o las dos versiones más recientes.
    • Linux: Se prefiere Ubuntu o Debian.
  • Memoria (RAM): Se recomienda al menos 8 GB para ejecutar Docker.
  • Espacio en disco: 20 GB de almacenamiento libre.
  • Internet: Una conexión estable para descargar herramientas y dependencias.
  • Navegador: Google Chrome, Firefox o cualquier navegador moderno

​
2. Herramientas que necesitas

¿Primera vez usando Node.js o npm?No hay problema, te tenemos cubierto. Si eres nuevo con estas herramientas o no estás seguro de cómo instalarlas, consulta nuestra Guía para principiantes de Node.js y npm. Te guía a través de todo paso a paso.

​
3. Instalar el comando make

Midaz usa make para automatizar la configuración. Instálalo usando una de las siguientes opciones, dependiendo de tu sistema operativo:
  • Linux (Ubuntu/Debian) - abre Terminal y ejecuta:
sudo apt install make
  • macOS - abre Terminal y ejecuta:
brew install make
  • Windows - abre PowerShell como Administrador y ejecuta:
choco install make

​
4. (Solo Windows) Instalar WSL

Midaz funciona mejor en un entorno Linux. Si estás en Windows, sigue estos pasos para instalar y usar WSL (Subsistema de Windows para Linux):

​
Instalar WSL

1
Presiona Win + R, escribe powershell y haz clic derecho para ejecutar como Administrador.
2
Ejecuta el siguiente comando:
wsl --install
3
Reinicia tu computadora si se te solicita.
Esto instala Ubuntu de manera predeterminada. Después del reinicio, se te pedirá crear un nombre de usuario y contraseña; elige lo que gustes (esto no afectará a Windows). Para más información sobre WSL, consulta la documentación oficial de Microsoft.
ConsejoSolo necesitas hacer esto una vez. La próxima vez, simplemente busca Ubuntu en el Menú de Inicio para abrir WSL.

​
Configuración de la Suite Midaz All-in-One

Esta es la forma más fácil de tener la experiencia completa de Midaz funcionando en tu computadora. Ya sea que estés probando cosas o comenzando el desarrollo, los pasos a continuación te guiarán a través de todo, sin necesidad de conocimientos técnicos profundos.

​
Paso 1 - Abre tu terminal

Necesitarás usar una terminal para ejecutar algunos comandos.
  • En macOS o Linux, puedes abrir la aplicación Terminal.
  • En Windows, abre la aplicación Ubuntu (WSL) si la has configurado.
Consejo¿No estás seguro de cómo abrir tu terminal? Consulta la guía de Conceptos básicos de línea de comandos.

​
Paso 2 - Descargar la Suite Midaz All-in-One

Este paso copia el código de Midaz desde GitHub a tu computadora. Para hacerlo, ejecuta este comando: 
git clone --recurse-submodules git@github.com:LerianStudio/midaz-stack.git
Ahora tendrás una carpeta llamada midaz-stack con todo lo que necesitas.

​
Paso 3 - Navega a la carpeta de Midaz

Ahora vamos a movernos a esa carpeta para que puedas trabajar con ella: 
cd midaz-stack
Ahora estás dentro del directorio del proyecto Midaz y listo para lanzar la suite.

​
Paso 4 - Inicia la Suite Midaz

Antes de ejecutar este comando:
  • Asegúrate de que Docker esté ejecutándose en tu máquina.
  • Si estás usando Windows, asegúrate de estar dentro de WSL (Subsistema de Windows para Linux).
Ejecuta este comando para iniciar todo de una vez: 
make up
Esto lanzará todos los servicios de Midaz, incluidas las APIs y Console. La primera vez puede tardar un poco más mientras todo se configura.

​
Paso 5 - Abre Midaz en tu navegador

Una vez que los servicios estén en funcionamiento, puedes visitarlos en tu navegador:
ImportanteEstos enlaces solo funcionan mientras la Suite Midaz esté ejecutándose en tu terminal.
¿Quieres explorar las APIs de Midaz?Dirígete a nuestra Referencia de API para comenzar a probar endpoints y aprender qué hacen.

​
Autenticación

A partir de Midaz v1.49, la autenticación ya no es requerida en la versión Community. Puedes hacer solicitudes a las APIs de Midaz directamente. Pronto, podrás usar nuestro plugin Auth & Identity para agregar las funciones de autenticación a tu entorno. Para más información, contacta a un representante de ventas.
Versiones anterioresSi estás usando una versión anterior de Midaz, accede a nuestra documentación de autenticación.

​
Comandos adicionales

También puedes usar los siguientes comandos:
  • Iniciar los servicios: make start
  • Detener los servicios: make stop o make down
  • Reiniciar los servicios: make restart
  • Reconstruir y reiniciar: make rebuild-up
  • Construir todos los servicios: make build
  • Limpiar todos los recursos: make clean
  • Mostrar ayuda: make help (para todos los comandos disponibles)
  • Mostrar comandos de Midaz: make midaz-help
  • Mostrar comandos de Console: make midaz-console-help

​
Comandos de desarrollo

Para propósitos de desarrollo, puedes ejecutar comandos específicos para cada componente:

​
Ejecutar un comando de Midaz

Usa el siguiente comando para ejecutar comandos específicos de Midaz Core: 
cd midaz && make <command>

​
Ejecutar un comando de Midaz Console

Usa el siguiente comando para ejecutar comandos específicos de Midaz Console: 
cd midaz-console && npm run <command>

​
Próximos pasos

Una vez que tu configuración esté completa, puedes:
  1. Explorar las APIs: Usa la colección de Postman en la carpeta postman de tu repositorio o descárgala aquí.
  2. Construir tu primera estructura: Consulta la Guía de inicio rápido para crear tu primera estructura de Midaz.

​
¿Necesitas ayuda?

Si tienes preguntas o encuentras problemas, estamos aquí para ayudarte:
  • Directrices de contribución: Aprende cómo contribuir al proyecto Midaz aquí.
  • Únete a la comunidad: Conéctate con nosotros en Discord.
  • Problemas abiertos: Encuentra problemas para principiantes en los que contribuir o propón los tuyos propios.
¡Juntos, construyamos el futuro de la gestión de Ledgers!