Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 4.15 KB

README.md

File metadata and controls

93 lines (68 loc) · 4.15 KB
Raw

CodeFactor

🤖 Discord QR Bot

Un bot de discord que proporciona un código QR dada una dirección url, o el nombre de usuario del que invoca el comando.

Si quieres añadir este bot a tu server accede al siguiente link

TABLA DE CONTENIDOS

COMANDOS

Una vez ya hayas invitado al bot a tu servidor de discord, podrás utilizar los comandos. Para soliciar los códigos QR, se pide al bot mediante comandos slash /

  • /url2qr http://example.com Red
    En el comando /url2qr deberás introducir seguidamente una dirección web válida y se abrirá un desplegable para que elijas el color que quiras que tenga el código qr.

  • /user2qr
    El bot te devolverá un código que representará tu nombre de usuario.

CÓDIGO

De las varias librerías de terceros publicadas en la documentación de discord, he elegido la librería discord.js. Se ve una librería solida y muy activa en github.
Este bot se ha programado con Typescript, creando un entorno de tipado seguro.
Para la creación de los códigos qr se hace uso de la libreria node-qrcode.
Se cuenta con Jest como framework para el desarrollo de tests.

La estructura de carpetas del código es la siguiente:

.├── src
  ├── commands                  # Comandos, un archivo por comando.
  ├── utils                     # Funciones utilitarias que se utilizan en los comandos
  ├── types                     # Tipos
  ├── config.ts                 # Configuración para manejar el archivo .env, que de error si falta una variable
  ├── deploycommands.ts         # Script para registrar los comandos
  ├── eventHandlers.ts          # Funciones que se pasarán como callbacks o los registros de eventos
  └── index.ts                  # Archivo principal, login y registro de eventos
 └── test                       # Tests unitarios

INSTALAR

Para desarrollar a partir de este proyecto puedes hacerlo de 2 formas, o directamente con node corriendo en tu máquina o hacer uso de docker si lo prefieres.

Importante : Debes crear una aplicación en el portal de desarrollo de Discord. De esta aplicación necesitarás el bot token y el client id, que deberás introducir en un archivo .env. Tienes una plantilla en el archivo example.env.

Descarga el código fuente
git clone https://github.com/davidfers/discord-qr-bot.git

Node

Debes tener Node 16.11 o mayor.
Ejecutar yarn o npm install

Docker

Construir la imagen
docker build --tag discord-qr-bot .

Iniciar contenedor
docker run --name discord-qr-bot --env-file .env -v ${PWD}:/app discord-qr-bot

o con Docker Compose
docker-compose up -d

USAR

Para registrar los comandos en el bot ejecutar el comando
yarn deploy-commands o npm run deploy-commands

Inicia el bot en modo desarrollo haciendo uso de ts-node-dev para contar con reincios automáticos cada vez que modificamos un archivo.
yarn dev o npm run dev

En docker
docker-compose up -d

Una vez acabado con el desarrollo compilar con
yarn build o npm run build

Se creará una carpeta dist/ con el código compilado a javascript y podrás inciar el bot con el comando
yarn start, npm start o directamente node dist/index.js

TESTS

Este proyecto cuenta con tests unitarios para testear funciones utilitarias o el comportamiento de los comandos.
Ejecutar los tests con
yarn test o npm run test