whatbot

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 70 Open GitHub ↗

GPT based chat bot for WhatsApp which uses the OpenAI API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## About The Project

This is a basic GPT chat bot for WhatsApp which uses the OpenAI API. It is written in JavaScript using Node.js.

### Prerequisites

* npm
```sh
npm install npm@latest -g
```
* API keys from OpenAI at https://openai.com.

### Installation

1. Clone the repo
```sh
git clone https://github.com/theshanergy/whatbot.git
```
2. Install NPM packages
```sh
npm install
```
3. Create an .env file containing your OpenAI secret API key as follows:
```sh
OPENAI_SECRET_KEY="<Secret key>"
```
4. Optionally set a default prompt in your .env file to give your bot a different personality:
```sh
DEFAULT_PROMPT="<Your custom prompt here>"
```

## Example Prompts

Prompts should be written in the first person and are used to define your bots personality and ego. ie:

> My name is Albert Einstein. I am a theoretical physicist who developed the theory of relativity.

The more detail you offer in your prompt, the better your responses will be.

## Usage

1. Run the bot:
```sh
npm run start
```
2. Open WhatsApp on your phone, select 'WhatsApp Web' from the settings menu, then scan the provided QR code.
3. Choose from the list of recent chats which you would like to activate the bot for. Use space key to select.
4. Sit back and watch the bot respond automatically to incoming messages from your selected contacts.

whatbot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README