3.2 KiB
CONTRIBUTING
Requerimientos:
- Node v16 o superior descargar node
- Yarn como gestor de paquetes. En el link conseguirás las intrucciones para instalar yarn.
- VSCode (recomendado): Editor de código con plugins.
- Conventional Commits (plugin-vscode) este plugin te ayudará a crear commit semántico.
- Se usará la rama dev (https://github.com/leifermendez/bot-whatsapp/tree/dev) como rama principal hasta que se haga oficialmente el lanzamiento de la V2.
🚀 Iniciando
Clonar repo rama dev
git clone --branch dev https://github.com/codigoencasa/bot-whatsapp
Instalar dependencias
cd bot-whatsapp
yarn install
Compilar (build)
Para compilar la aplicación es necesario ejecutar este comando, el cual genera un directorio lib dentro de los paquetes del monorepo.
yarn build
Example-app Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de ejemplo.
yarn run cli
Selecionas (mediante las flechas arriba y abajo) el proveedor que quieras usar y cuando estes sobre el presiona la barra de espacio, igualmente selecciona la base de datos que quieras usar.
Se creó un subdirecorio con el nombre del proveedor y base de datos que seleccionaste, ejemplo: base-bailey-mysql
Dentro de ese directorio necesitas editar el archivo package.json y borrar las siguientes lineas:
"@bot-whatsapp/bot": "latest",
"@bot-whatsapp/cli": "latest",
"@bot-whatsapp/database": "latest",
"@bot-whatsapp/provider": "latest",
Cambiate al directorio creado ejemplo: base-bailey-mysql
cd base-baileys-mysql
Ejecuta los comandos:
npm install
npm run pre-copy
npm start
En el caso de MySql y Mongo es necesario especificar en app.js los datos de la conexión, ejemplo de 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'
🤔 Preguntas frecuentes
- ¿Como puedo hacer aportaciones de código en el proyecto?: Ver Video
- ¿Como ejecutar el entorno de pruebas?: Ver Video
- ¿Como crear un nuevo proveedor?: Ver Video
- ¿Que son los GithubActions?: Ver Video
NOTA: Documento en constante actualización....