1lc

🚀 ChatGPT Integration Tool for WeChat Ecosystem: Deployment and Usage Guide

This is a tool that integrates ChatGPT into the WeChat ecosystem, supporting access via Terminal or other plugins. Here's how to install, deploy, and use it.

📦 Installation

Project Introduction

This is a tool that integrates ChatGPT into the WeChat ecosystem, supporting access via Terminal or other plugins. Please follow the steps below to install:

1. Clone the repository

   git clone https://github.com/zhayujie/chatgpt-on-wechat.git
   cd chatgpt-on-wechat
   

2. Install dependencies

   pip install -r requirements.txt
   

3. Project structure

   chatgpt-on-wechat/
   ├── channel/       # Message sending and receiving processing module
   ├── plugins/      # Plugin extension directory
   └── config.json    # Global configuration file
   

🚀 Deployment Guide

Local Deployment

Download the source code and run

1. After cloning the repository, enter the project directory:

   cd chatgpt-on-wechat
   

2. Run the main program:

   python main.py
   

Configuration file description

• config.json: Contains global configuration parameters, such as API keys and plugin settings. The default content is as follows:

  {
    "open_ai_api_key": "your-api-key",
    "group_name_white_list": ["group1", "group2"],
    "plugin_settings": {}
  }
  

Docker Deployment

Environment setup

1. Download and install Docker.
2. Start the Docker service.

Operation guide

1. Create a docker-compose.yml file:

   version: '3'
   services:
     chatgpt-wechat:
       build: .
       ports:
         - "8000:8000"
       environment:
         - OPEN_AI_API_KEY=your-api-key
   

2. Build and start the service:

   docker-compose up --build
   

Railway Deployment

Project deployment

1. Upload the source code to the Railway platform.
2. Configure environment variables, including OPEN_AI_API_KEY.
3. Set the running command to python main.py.

❓ Frequently Asked Questions

1. How to obtain an API key?

Go to the OpenAI official website to register and create an application to obtain an API access token.

2. What if the plugin doesn't work properly?

Check if the plugin configuration is correct and refer to the project documentation for compatibility requirements.

3. Errors occur when deploying to Docker

Ensure that the Docker environment is running properly, check if there are syntax errors in the docker-compose.yml file, and confirm that the port mapping and environment variable settings are correct.

🛠️ Development Guide

Plugin Development

1. Create a new plugin in the plugins/ directory.
2. Implement the message processing logic and register it with the main program.

Submitting Code

Push your changes to the GitHub repository or contribute to the project via a Pull Request.

📞 Contact Information

• Report issues: Report issues in Issues.
• Submit feature requests: Describe your requirements in detail and attach usage scenarios.
• Join the community: Welcome to join the open-source communication group to participate in discussions and contributions.

By following the steps above, you can easily deploy and use this tool and customize it according to your needs.