hummus

README

Hummus

Hummus is a GoUAE Community project that bridges the Coders(HQ) WhatsApp communication channels with Discord.

Do note that for now, we aim to just be read-only, sending messages one way (WhatsApp -> Discord). Given the constraints of WhatsApp.

Quickstart

[!NOTE] Make sure you have go installed.

1. Clone the repository

git clone https://github.com/GoUAE/Hummus
cd Hummus

1. Copy the .env.example file to .env

cp .env.example .env

1. Fill in the necessary environment variables in the .env file. You'll need to provide values for the following variables:

DISCORD_BOT_TOKENDISCORD_CHANNEL_ID=
DISCORD_WEBHOOK_ID=
DISCORD_WEBHOOK_TOKEN=
DISCORD_FALLBACK_AVATAR_URL=
# We support only 1 WhatsApp chat for now, you'll have to get its ID manually (instructions TBA).
WA_GOUAE_JID=

1. Install the dependencies

go mod download

1. Run the project

go run

1. Scan the QR code to log in to the WhatsApp client.

Maintainers

• Gaurav-Gosain

LICENSE

This project is licensed under the MIT License.