En el mundo del desarrollo, a veces necesitamos herramientas simples pero poderosas que nos ayuden a resolver problemas rápidamente. Hoy quiero hablarte de mini-qr, un proyecto minimalista escrito en Go que te permite generar códigos QR desde la terminal o mediante una interfaz gráfica. Si alguna vez has necesitado generar un código QR para compartir un enlace, un texto o cualquier otra información, esta herramienta es para ti. Además, gracias a Docker y Docker Compose, puedes usarla en cualquier sistema sin preocuparte por dependencias o configuraciones complicadas.
¿Qué es mini-qr?
mini-qr es un proyecto de código abierto creado por lyqht que permite generar códigos QR de manera rápida y sencilla. Está escrito en Go, un lenguaje conocido por su eficiencia y simplicidad, lo que hace que esta herramienta sea ligera y fácil de usar.
El proyecto es ideal para desarrolladores que buscan una solución sin complicaciones para integrar la generación de códigos QR en sus flujos de trabajo, ya sea para uso personal o en aplicaciones más grandes. Además, su capacidad para ejecutarse en Docker y su interfaz gráfica lo hacen accesible para todo tipo de usuarios.
Características principales:
- Minimalista: Solo hace una cosa y la hace bien: generar códigos QR.
- Fácil de usar: Con solo un comando en la terminal o mediante una interfaz gráfica, puedes crear un código QR.
- Personalizable: Permite ajustar el tamaño del código QR y el contenido que deseas codificar.
- Multiplataforma: Al estar escrito en Go y ser compatible con Docker, funciona en Windows, macOS y Linux.
- Interfaz gráfica: Ideal para usuarios que prefieren una solución visual.
- Dockerizado: Fácil de instalar y ejecutar en cualquier entorno.
- Docker Compose: Simplifica la ejecución con un solo comando.
Puedes probar la interfaz gráfica de mini-qr directamente en tu navegador visitando el siguiente enlace:
Esta vista previa te permitirá experimentar con todas las funcionalidades de mini-qr sin necesidad de instalar nada. ¡Pruébalo y descubre lo fácil que es generar códigos QR personalizados!
¿Cómo funciona?
El funcionamiento de mini-qr es muy sencillo. Puedes usarlo de dos maneras: desde la terminal o mediante su interfaz gráfica. Además, gracias a Docker y Docker Compose, puedes ejecutarlo en cualquier sistema sin preocuparte por dependencias.
Opción 1: Desde la terminal
Basta con ejecutar un comando en la terminal, proporcionar el texto o enlace que deseas convertir en un código QR, y listo. Aquí tienes un ejemplo básico:
mini-qr -content "https://josapino.dev" -output qr.png
Este comando generará un código QR que redirige a tu blog y lo guardará en un archivo llamado qr.png
.
Opción 2: Usando Docker Compose (ideal para Portainer y otros entornos)
Si prefieres una solución rápida y desplegable en entornos como Portainer, puedes usar el archivo docker-compose.yml
incluido en el repositorio. Este archivo ya está configurado para que puedas ejecutar mini-qr con un solo comando, sin necesidad de clonar el repositorio o hacer configuraciones adicionales.
Pasos para implementar mini-qr con Docker Compose:
- Crea un archivo
docker-compose.yml
:
Si no quieres clonar el repositorio, simplemente crea un archivodocker-compose.yml
con el siguiente contenido:
services:
mini-qr:
image: ghcr.io/lyqht/mini-qr:latest
container_name: mini-qr
ports:
- 8081:8080
restart: unless-stopped
- Ejecuta Docker Compose:
En la misma carpeta donde creaste el archivodocker-compose.yml
, ejecuta el siguiente comando:
docker-compose up -d
Esto descargará la imagen de mini-qr y levantará el contenedor en segundo plano.
- Accede a la interfaz gráfica:
Abre tu navegador y visitahttp://localhost:8081
. Verás una interfaz sencilla donde puedes introducir el contenido que deseas convertir en un código QR y descargar el resultado.
Implementación en Portainer:
Si estás usando Portainer, puedes implementar mini-qr directamente desde la interfaz gráfica de Portainer:
- Copia el contenido del
docker-compose.yml
:
Usa el YAML proporcionado anteriormente. - Ve a la sección "Stacks" en Portainer:
- Haz clic en "Add Stack".
- Pega el contenido del
docker-compose.yml
en el editor. - Asigna un nombre a tu stack (por ejemplo,
mini-qr
). - Haz clic en "Deploy the stack".
- Accede a la interfaz gráfica:
Una vez desplegado, visitahttp://tuservidor:8081
para acceder a la interfaz de mini-qr.
¿Por qué usar Docker Compose?
- Portabilidad: Puedes implementar mini-qr en cualquier entorno que soporte Docker Compose, como Portainer, un servidor local o en la nube.
- Facilidad: Con un solo archivo YAML, tienes todo lo necesario para levantar el servicio.
- Escalabilidad: Si en el futuro necesitas añadir más servicios o configuraciones, Docker Compose lo hace sencillo.
¿Por qué me gusta este proyecto?
- Simplicidad: No necesitas instalar dependencias complicadas o aprender a usar una interfaz gráfica. Todo se hace desde la terminal o con Docker Compose.
- Velocidad: Al estar escrito en Go, la generación del código QR es casi instantánea.
- Código abierto: Puedes revisar el código, modificarlo y adaptarlo a tus necesidades.
- Dockerizado: Facilita su uso en cualquier entorno sin preocuparte por configuraciones adicionales.
- Interfaz gráfica: Hace que la herramienta sea accesible para usuarios menos técnicos.
- Docker Compose: Simplifica la ejecución con un solo comando.
¿Cómo contribuir o personalizar?
Si eres como yo y te gusta trastear con el código, mini-qr es un proyecto perfecto para aprender más sobre Go, Docker y cómo funcionan los códigos QR. Puedes clonar el repositorio, añadir nuevas funcionalidades (como cambiar los colores del QR o añadir un logo), o simplemente estudiar cómo está implementado.
Para clonar el repositorio:
git clone https://github.com/lyqht/mini-qr.git
Conclusión:
mini-qr es un ejemplo perfecto de cómo una herramienta simple puede resolver un problema común de manera eficiente. Ya sea que prefieras usar la terminal, Docker Compose o su interfaz gráfica, esta herramienta tiene algo para todos. Si necesitas generar códigos QR con frecuencia, te recomiendo que le des una oportunidad. Además, al ser un proyecto de código abierto, puedes aprender de él, contribuir o incluso inspirarte para crear tus propias herramientas minimalistas.
¿Has usado alguna vez una herramienta similar? ¿Qué otras funcionalidades añadirías a mini-qr? ¡Déjame tus comentarios y hablemos sobre ello!