https://github.com/gabrielh-silvestre/zap-hub

Bun application that allows the users to interact with ChatGPT using WhatsApp groups
https://github.com/gabrielh-silvestre/zap-hub

bun gpt-4 openai whatsapp-web

Last synced: 23 days ago
JSON representation

Bun application that allows the users to interact with ChatGPT using WhatsApp groups

• Host: GitHub
• URL: https://github.com/gabrielh-silvestre/zap-hub
• Owner: gabrielh-silvestre
• Created: 2023-12-26T20:54:45.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-17T14:07:51.000Z (10 months ago)
• Last Synced: 2024-10-01T07:41:10.765Z (about 1 month ago)
• Topics: bun, gpt-4, openai, whatsapp-web
• Language: TypeScript
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zap-hub

## Description

This is a simple Node.js application that allows users to interact with ChatGPT using WhatsApp.

The user should be able to create a WhatsApp group and configure the Zap-Hub inside the group.

## How to use

1. Create a WhatsApp group

2. Name the group with the following prefix: `[GPT]`

3. Follow the instructions in the group to configure the Zap-Hub

### Availabe-Commands

- `!help` - Show the available commands

- `!register` - Set the OpenAI API key _(the message with the key will be deleted after setted)_

- `!unregister` - Remove the OpenAI API key

- `!gpt` - Send a message to the GPT-4 API, you can add a image to the message

- `` - Send audios from the configured WhatsApp Group to the GPT-4 API _(will send all received/created audios)_

### Important

- The Zap-Hub will only work in the group that was configured

- The Zap-Hub configuration is stored in the group description _(the description will be encoded)_

- You should NOT edit manually the Zap-Hub group description

- The Zap-Hub will use **YOUR** WhatsApp acount to receive and send messages, so have in mind that the Zap-Hub will always answer as **YOU** _(it will use your profile)_

## How to run

### Requirements

- Bun 1.0.16

### Steps

1. Clone this repository

2. Install the dependencies: `bun install`

3. Run the application: `bun run src/index.ts`

4. Login with your WhatsApp account using the QR Code **All the credentials are stored locally**