MACbot

Este bot es la nueva y mejorada herramienta de bolsillo que todo Mackienzie debe tener. Él te mantendrá al tanto de tus responsabilidades como miembro de la agrupación (y también como futuro miembro).

Install

Clone and start the project

Tienes que llenar todas las variables de entorno para que el proyecto funcione.

git clone https://github.com/MAC-USB/MACbot.git
cd MACbot
cp .env-example .env

Running the bot with Docker

Después de llenar las variables de entorno, puedes iniciar el proyecto con Docker-compose.

NOTA: Si no tienes instalado Docker, puedes seguir la guía de instalación aquí.

Puedes correr el bot en el entorno de desarrollo o en el de producción. Simplemente especifica el entorno en la variable de entorno NODE_ENV en el archivo .env. Para correr el bot en el entorno de desarrollo, debes especificar development y para el de producción, production.

docker compose build
docker compose up -d

Para ver los logs del bot y la bd en conjunto, puedes usar el siguiente comando:

docker compose logs -f

Para ver los logs del bot y la bd por separado:

docker compose logs -f macbot
docker compose logs -f postgres

Finalmente, para detener el bot puedes usar el siguiente comando:

docker compose down

Development

Si quieres contribuir al proyecto, si es necesario que tengas instalado Node.js y hacer la instalación de las dependencias.

npm install

Esto para que puedan cargarse las configuraciones de ESLint y Prettier.

Google Sheet API credentials

Para sacar las credenciales de la API de Google Sheets tienes que visitar: https://console.developers.google.com

mkdir credentials
touch credentials/MACbot_secret.json

Documentation

...

cuevasrja/MACbot