Skip to content

AlbertoLinde/NUWE-DiscordQR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[Nuwe] 🤖 Discord BOT

CodeFactor Quality Gate Status


Este proyecto consiste en la realización de un Discord BOT en el que podemos interactuar con el para generar códigos QR. Consiste en una serie de retos semanales que se están realizando en la plataforma Nuwe.

Indice


Construido con 🛠️


Invitar 📩

Si quieres invitar al BOT que he desarrollado simplemente agregalo a tu servidor 🤖 Invitar a tu servidor

De esta manera invitarás al BOT que he desarrollado directamente a tu servidor, ten en cuenta que lo tengo lanzado en local, por lo tanto, puede que lo invites y no esté encendido. Puedes hablarme por Discord y lo enciendo para que realices algunas pruebas iAbdy#2553.


Instalación (Local)

  1. Comprueba que tienes en tu equipo instalado Node. Abre CMD o PowerShell y escribe:

      node -v
    
  2. Clona este repositorio

      git clone https://github.com/AlbertoLinde/NUWE-DiscordQR
    
  3. Instala todas las dependencias necesarias

      cd folder/project
    
      npm install
    
  4. Para poder ejecutar tu propio BOT necesitarás un TOKEN de Discord. Tendrás que generar un bot en el siguiente enlace Discord Developer Portal. Genera un bot con los permisos que desees.

  5. Renombra el fichero llamado .env.rename => .env y en su interior coloca el valor de tu TOKEN.

  6. Para activar el BOT (local) simplemente poniendote en la ruta del proyecto escribe el siguiente comando y este se encenderá si toda la configuración es correcta.

   node .
  1. Invitar al BOT a tu servidor: Para realizar esto, en el portal de developers encontrarás la URL que has generado para invitar al bot a tu servidor.

Features 🔨

  • Task-1: Configurar el bot de discord y poder instalarlo en otros servers.
  • Task-2: Crear un endpoint que permita recibir un string y a través de una API devuelva el código QR. (En un principio utilizaba la API de Google pero he encontrado una librería mejor ya que puedo aportar color y otras configuraciones).
  • Task-3: Hacer que el bot discord tenga un comando en el cual se pueda enviar un string, conecte con el endpoint anterior y devuelva al usuario el código QR.
  • Task-4: QR para URLs, implementar una función que permita revisar si el código enviado es un URL o no, para que así asegurar que el código QR redirija hacía algún punto.
  • Task-5: Agregar algún tipo de testing, ya sea utilizando Insomnia, postman o testing unitario.
  • Task-6: Permitir que el usuario pueda escoger el color del QR generado.
  • Task-7: Generar un comando que devuelva un QR que se generará a partir del nombre de usuario.

Features || Ideas Pendientes 🔨

  • ❗ Realizar los Test con la librería Corde
  • ❗ Refactorizar
  • ❗ Implementar un CLI completo a través de los comandos. (Pruebas anteriores)

Comandos

Si no especificas ningún color por defecto se utilizará el negro como color principal para el QR.

QR String

QR_STRING

QR URL

QRURL_COLOR

QRURL_NOCOLOR

USER

QRUSER

HELP

QRHELP


Contacto 📩

LinkedIn - Twitter - Web -

About

Week 3 - QR Generator with Discord Bot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published