Nos alegra que est茅s interesado en colaborar en nuestro proyecto. Para hacerlo, puedes contribuir de diversas maneras, la principal es aportando tu conocimiento y habilidades para mejorar el repositorio, ya sea actualizando la documentaci贸n, mejorando el c贸digo o revisando problemas pendientes en los issues.
Tambi茅n agradecemos los aportes econ贸micos, que utilizaremos para diversos fines relacionados con el desarrollo y mantenimiento del proyecto. Puedes ver m谩s detalles aqu铆: ver m谩s
Requisitos: Para poder aportar al proyecto necesitar谩s tener:
- Node v20 o superior. Puedes descargar Node aqu铆: descargar node
- pnpm como administrador de paquetes. Puedes seguir el enlace para saber c贸mo instalarlo.
- VSCode es el editor de c贸digo que recomendamos, ya que cuenta con plugins 煤tiles.
- Conventional Commits es un plugin de VSCode que te ayudar谩 a crear commits sem谩nticos, siguiendo buenas pr谩cticas.
Hacer Fork del Proyecto
Antes de comenzar, es necesario que hagas un fork del proyecto en tu propia cuenta de GitHub. Esto te permitir谩 trabajar en tu propia copia del repositorio. Haz clic en el siguiente enlace para realizar el fork: aqu铆
Clona repositorio (desde tu fork)
git clone https://github.com/TU_USERNAME/bot-whatsapp
Instalar dependencias Entra a la carpeta del proyecto y ejecuta el siguiente comando para instalar las dependencias necesarias.
cd bot-whatsapp
pnpm install
Compilar (build)
Para compilar la aplicaci贸n, debes ejecutar el siguiente comando, el cual generar谩 un directorio lib dentro de los paquetes del monorepo.
pnpm run build
Aplicaci贸n de ejemplo Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un bot de ejemplo.
pnpm run cli
Test e2e Todos los cambios realizados deben de pasar las pruebas end-to-end
pnpm run test.e2e
Selecciona el proveedor y la base de datos que quieras usar usando las flechas arriba y abajo de tu teclado y marc谩ndolas con la barra de espacio.
Este proceso crear谩 un subdirectorio con el nombre del proveedor y la base de datos que seleccionaste, por ejemplo: base-bailey-mysql
Dentro de ese directorio, tendr谩s que editar el archivo package.json y borrar las siguientes l铆neas:
"@bot-whatsapp/bot": "latest",
"@bot-whatsapp/cli": "latest",
"@bot-whatsapp/database": "latest",
"@bot-whatsapp/provider": "latest",
A continuaci贸n, debes desplazarte al directorio que acabas de crear, por ejemplo: base-baileys-mysql
cd base-baileys-mysql
Y ejecuta los siguientes comandos:
npm install
npm run pre-copy
npm start
En el caso de MySql y Mongo, necesitar谩s especificar en el archivo app.js los datos de la conexi贸n, por ejemplo, para MySql:
const BaileysProvider = require('@bot-whatsapp/provider/baileys')
const MySQLAdapter = require('@bot-whatsapp/database/mysql')
/**
* Declaramos las conexiones de MySQL
*/
const MYSQL_DB_HOST = 'localhost'
const MYSQL_DB_USER = 'usr'
const MYSQL_DB_PASSWORD = 'pass'
const MYSQL_DB_NAME = 'bot'NOTA: Si encuentras informaci贸n que podr铆a mejorarse en este documento o alg煤n error ortogr谩fico que dificulte la comprensi贸n, eres libre de corregirlo.(edita aqui)