PeterCat: Creating a smart Q&A bot for GitHub with official website integration for professional and technical online customer service

General Introduction

PeterCat is a smart Q&A bot solution for GitHub community maintainers and developers. PeterCat provides a conversational Q&A Agent configuration system, self-hosted deployment solution, and a convenient all-in-one application SDK that allows users to create Q&A bots for their GitHub repositories with a single click and quickly integrate them into various official websites or projects. PeterCat's core features include automatic knowledge repository and multi-platform integration and efficient technical support ecosystem, aiming to improve the efficiency of community technical support.

Function List

• Conversational Q&A Agent Configuration System: Auto-completes bot configuration, including Prompt, name, avatar, opener, and more.
• Self-hosted deployment options: Supports AWS and local deployments to ensure data security and privacy.
• All-in-One Application SDK: Conveniently integrated into the official website or project, supporting a variety of integration methods.
• Automatic Knowledge Entry: Automatically repository GitHub documents and issues as a knowledge base for bots.
• Multi-Platform Integration: Support dialog application SDK integration to the official website, GitHub APP one-click installation to GitHub repository.
• Project management supportIt supports Project Query, Reply Discussion, PR Summary, Code Review, Issue Management and so on.

Using Help

Installation process

1. Self-hosted deployment::
   • Local Startup Service::
   1. Clone the PeterCat repository locally.
   2. Configure environment variables, making sure that all required variables are set.
   3. (of a computer) run docker-compose up Start the service.
   • Deploying to AWS::
   1. Configure AWS-related environment variables.
   2. Deploy the service using the AWS CLI to ensure that all resources are properly configured.
2. GitHub APP Installation::
   • Install PeterCat APP in your GitHub repository to authorize access to the repository.
   • Configure the APP settings to ensure proper connection to the PeterCat service.

Guidelines for use

1. Creating a Smart Answer Bot::
   • Enter the GitHub repository address or name in the PeterCat console.
   • The system will automatically generate the bot's configuration, including Prompt, name, avatar, etc.
   • After completing the configuration, the robot will automatically start working on the related technical support requests.
2. Knowledge repository::
   • Once the bot is created, all related GitHub documents and issues will be automatically reposited.
   • Users can view and manage knowledge base content in the console to ensure the accuracy and timeliness of bot responses.
3. Multi-Platform Integration::
   • Use the Dialog App SDK to integrate the bot into an official website or project.
   • Install PeterCat APP in your GitHub repository for one-click integration.
4. Project management support::
   • The PeterCat console allows users to check project status, reply to Discussion, view PR Summary and perform Code Review.
   • Supports Issue management, including checking Issue, raising Issue and replying Issue.

Detailed Operation Procedure

1. Configuring Environment Variables::
   • exist .env.local file to set the client environment variables, such as NEXT_PUBLIC_API_DOMAINThe
   • exist .env file to set the server environment variables, such as API_URL,WEB_URL etc.
2. Starting services::
   • (of a computer) run docker-compose up Start the local service.
   • Ensure that all services are up and running by visiting http://localhost:3000 View Console.
3. Managing the knowledge base::
   • View inbound documents and issues in the console.
   • Manually add or update knowledge base content to ensure the accuracy of bot responses.
4. Integration to the official website::
   • Use the Conversation App SDK to integrate the bot into an official website or project.
   • Configure the SDK settings to ensure proper connection to the PeterCat service.