Skip to content

Commit 6d3a385

Browse files
codingwithzazcodingwithzaz
authored
Update README.md
1 parent 6268d39 commit 6d3a385

File tree

1 file changed

+109
-8
lines changed

1 file changed

+109
-8
lines changed

‎README.md

+109-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
## ChatConnect-Pro Documentation
1+
## 🚀💬 ChatConnect-Pro Documentation
2+
![GitHub Views](https://komarev.com/ghpvc/?username=ChatConnect-Pro&style=plastic)
23

3-
### Introduction
4+
5+
💲Donation: Bitcoin (Binance🪙)
6+
```py
7+
195XfKjaHkBedXptLk2iRAL3Qip2YHqzHZ
8+
```
9+
10+
### 🌟 Introduction
411

512
ChatConnect-Pro is an advanced integration project that seamlessly connects the WhatsApp platform with the OpenAI Chatbot, facilitating efficient communication and information exchange between the two platforms. Leveraging sophisticated automation tools and cutting-edge conversational AI capabilities, ChatConnect-Pro streamlines the interaction process without the need for OpenAI API keys, relying solely on the presence of a signed-in ChatGPT window.
613

7-
### Requirements
14+
### 📝 Requirements
815

916
Before deploying the ChatConnect-Pro project, ensure the following prerequisites are in place:
1017

@@ -16,7 +23,100 @@ Before deploying the ChatConnect-Pro project, ensure the following prerequisites
1623
- **Whatsmeow:** Install the Whatsmeow library, which acts as a bridge for communication with the WhatsApp platform.
1724
- **SQLite:** Configure the SQLite database connector to support data storage and management within the project.
1825

19-
### Browser Configuration
26+
## :cloud: Pre-Installation
27+
:accessibility: Required Softwares
28+
<div align="center">
29+
<table>
30+
<tr>
31+
<th>Language</th>
32+
<th>Description</th>
33+
<th>Version</th>
34+
<th>Download Link</th>
35+
</tr>
36+
<tr>
37+
<td>Git</td>
38+
<td>Version control system</td>
39+
<td>2.42.1</td>
40+
<td><a href="https://www.git-scm.com/downloads">Download</a></td>
41+
</tr>
42+
<tr>
43+
<td>Python</td>
44+
<td>Programming language</td>
45+
<td>3.11.2</td>
46+
<td><a href="https://www.python.org/downloads">Download</a></td>
47+
</tr>
48+
<tr>
49+
<td>Go</td>
50+
<td>Programming language</td>
51+
<td>1.21.3</td>
52+
<td><a href="https://golang.org/dl/">Download</a></td>
53+
</tr>
54+
<tr>
55+
<td>Tdm-gcc</td>
56+
<td>MinGW-w64 based GCC for Windows</td>
57+
<td>10.3.0.2</td>
58+
<td><a href="https://jmeubank.github.io/tdm-gcc/download/">Download</a></td>
59+
</tr>
60+
</table>
61+
</div>
62+
63+
> While Python Installation:
64+
> Add python to path, Use Admin Privileges > Disable Path Limit at the end
65+
> Make sure to Restart your PC after installation of above softwares
66+
67+
## :cloud: Installation
68+
69+
Fireup your terminal/cmd📟
70+
```sh
71+
# Using Git
72+
git clone https://github.com/codingwithzaz/ChatConnect-Pro
73+
```
74+
75+
```sh
76+
cd ChatConnect-Pro
77+
```
78+
79+
```sh
80+
pip install -r requirements.txt
81+
```
82+
83+
```sh
84+
playwright install firefox # Regards server.py
85+
```
86+
if you want any other browser instead of firefox, such as webkit/chrome then you have to change the browser in server.py file also
87+
88+
```sh
89+
python server.py
90+
```
91+
Login for the first time
92+
93+
> At the same time, you have to run the ```whatsapp``` client also, that is ```main.go``` file.
94+
For this Fireup another terminal/cmd and goto the same folder "ChatConnect-Pro" and run the following command
95+
```
96+
go run main.go
97+
```
98+
> It will automatically install the required go packages
99+
100+
if you get the following error:
101+
> panic: failed to upgrade database: Binary was compiled with 'CGO_ENABLED=0', go-sqlite3 requires cgo to work. This is a stub
102+
> goroutine 1 [running]:
103+
> main.main()
104+
> C:/Users/vmwar/ChatConnect-Pro/main.go:74 +0x46e
105+
> exit status 2
106+
107+
Run the following command in the same terminal/cmd
108+
```
109+
set CGO_ENABLED=1
110+
```
111+
112+
> If you get the 'gcc' error, make sure you have installed the correct version of TDM-GCC
113+
114+
```go
115+
go run main.go
116+
```
117+
> First time it will take 5-10 to run completely!
118+
119+
### 🌐 Browser Configuration
20120

21121
To configure the browser settings for the ChatConnect-Pro project, follow these instructions:
22122

@@ -30,7 +130,7 @@ BROWSER = PLAY.firefox.launch_persistent_context(user_data_dir=PROFILE_DIR, head
30130

31131
- Additionally, you can change the headless mode by modifying the `headless=True` parameter. Setting it to `True` enables headless mode, which runs the browser without a user interface, making it ideal for automated tasks. Setting it to `False` activates the browser's graphical interface, allowing real-time visualization during script execution.
32132

33-
### Headless Mode
133+
### 💻 Headless Mode
34134

35135
The headless mode enables the browser to operate without a graphical user interface, allowing it to run in the background. This mode is particularly useful for automated tasks and server-side operations where a visible browser window is not required. It significantly reduces resource consumption and enhances the efficiency of the automation process.
36136

@@ -57,7 +157,7 @@ In this line, time.sleep(0.2) introduces a smaller delay of 0.2 seconds. This sh
57157
The strategic use of time.sleep at these specific lines demonstrates the function's efficient and optimized approach to wait for and retrieve the latest non-empty message from the ChatGPT interface, enhancing the overall performance and resource management of the ChatConnect-Pro project.
58158

59159

60-
### Usage
160+
### ⚙️ Usage
61161

62162
To effectively utilize the ChatConnect-Pro integration project, follow these steps:
63163

@@ -76,7 +176,7 @@ To effectively utilize the ChatConnect-Pro integration project, follow these ste
76176
5. **Monitoring and Interaction:**
77177
- Monitor the ongoing communication and interaction between the WhatsApp platform and the OpenAI Chatbot through the integrated communication channel. Leverage the powerful capabilities of ChatConnect-Pro to streamline communication processes and enhance the overall user experience for both WhatsApp users and the OpenAI Chatbot.
78178

79-
### Introduction
179+
### Server.py Introduction
80180
The `server.py` file is a Python script that facilitates communication between the OpenAI Chatbot and the WhatsApp platform. It establishes a connection between these two platforms, allowing seamless integration for the exchange of messages. The script utilizes the Flask web framework for creating the server, and the Playwright library for web automation tasks.
81181

82182
### Dependencies
@@ -163,4 +263,5 @@ The `multichat.py` script is designed to create a conversation between two insta
163263
- The `metaprompt` is used to identify and replace specific prompts during the conversation, ensuring the messages remain coherent and meaningful.
164264

165265
### Usage
166-
Ensure that the `server.py` script is already running on ports 5001 and 5002 before executing the `multichat.py` script. The script simulates a conversation between two instances of the OpenAI Chatbot, with each instance communicating with the other in an alternating manner. The `metaprompt` helps in maintaining the coherence and flow of the conversation.
266+
Ensure that the `server.py` script is already running on ports 5001 and 5002 before executing the `multichat.py` script. The script simulates a conversation between two instances of the OpenAI Chatbot, with each instance communicating with the other in an alternating manner. The `metaprompt` helps in maintaining the coherence and flow of the conversation.
267+

0 commit comments

Comments
 (0)