2.5 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
Seguir instrucciones En la consola encontraras los pasos a seguir
Observaciones Se debe tener en cuenta que si queremos utilizar una base de datos de MySQL, como muestra el ejemplo, será necesario actualizar las credenciales o crear previamente un usuario y una BBDD para que la conexión se realice correctamente. Las credenciales que usará la aplicación por defecto se encuentran en el fichero app.js y serán las siguientes:
const MYSQL_DB_HOST = 'localhost'
const MYSQL_DB_USER = 'user'
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....