/xfazt-bot

xFazt-bot pretende ser la solución definitiva al bot de Fazt Community para Discord.

Primary LanguageTypeScriptMIT LicenseMIT

xFaztBot para Fazt Community

dev chat All Contributors

xFaztBot es el modulo principal del Bot de Discord para Fazt Community, basado en la filosofía OpenSource y pensado para quienes buscan aprender y desarrollar sus capacidades en JavaScript, Typescript, paradigmas de programación, Bots y sobre todo de trabajo en equipo.

Sus principales funcionaledades serán:

  • Moderación de servidor por comandos simples.

  • Logging de actividades no deseadas en el servidor.

  • ** Mas por venir pronto **

  • Si deseas aportar al proyecto, no olvides leer la sección COLABORANDO y el documento CONTRIBUTING.md

Pre-requisitos de instalación

  • Node.JS 14.x o superior instalado
  • Git (cualquier versión) instalado.
  • Bash o Powershell para ejecucion de comandos al S.O

Instalacion

  • Clona este repositorio:
git clone https://github.com/faztcommunity/xfazt-bot.git
  • Estando en la raiz del proyecto, instala las dependencias mediante npm:
npm install
  • Crea un archivo .env en la raiz del proyecto y completalo con tu información.
    ver: variables de entorno
  • Corre el comando de desarrollo
npm run dev

y compila con npm run build

Uso del bot

Desde discord, con el bot encendido, corre el comando <br <prefix>help
Para ver la lista completa de comandos, o para ver la información detallada usa
<prefix>help command

O bien, visita la información en la wiki
Lista completa de comandos

Colaborando

Si lo que buscas es ayudar con el proyecto y conectar con una gran comunidad de desarrolladores de habla Hispana, entonces haz llegado al lugar correcto.

En primer lugar asegúrate de leer bien la documentacion que preparamos con mucho cariño, y principalmente el archivo CONTRIBUTING.md donde encontratas todas las guias necesarias para saber que hacer y entender como nos manejamos.

En segundo lugar, puedes ingresar a la sección ISSUES de nuestro repositorio. Donde encontrarás todas las características, bugs y aportes que estamos trabajando. Si estas perdido por cual comenzar, utilizamos el tag "good first issue" para identificar aquellos asuntos que son un buen punto de entrada para nuevos. Si lo que quieres es sugerir alguna nueva característica o reportar un bug que encontraste, puedes hacerlo creando un nuevo ISSUE (siguiendo las pautas que ya leíste 😉)

Por último si quieres contactar con quienes estan incolucrados en este proyecto, debajo encontraras una lista de los principales responsables de este bot, y también puedes unirte a la comunidad en Discord de Fazt Community (si esa para la cual estamos haciendo el bot) donde encontraras cientos (sino miles) de desarrolladores con los cuales compartir dudas e ideas, y tambien donde cada cierto tiempo iniciamos proyectos de este mismo estilo donde puedes ser parte desde la concepcion del mismo.

Colaboradores ✨


Lottie

💻 📖

SolidFox

📖

Este proyecto sigue las especificaciones de all-contributors. ¡Cualquier contribución es bienvendia!


Bajo la licencia MIT