はじめに
PeterCatは、GitHubコミュニティのメンテナや開発者のためのスマートなQ&Aボットソリューションです。PeterCatは、会話型Q&Aエージェントの設定システム、セルフホスト・デプロイメント・ソリューション、便利なオールインワン・アプリケーションSDKを提供しており、ユーザーはワンクリックでGitHubリポジトリ用のQ&Aボットを作成し、様々な公式ウェブサイトやプロジェクトに素早く統合することができます。PeterCatのコア機能には、自動ナレッジリポジトリ、マルチプラットフォーム統合、効率的なテクニカルサポートエコシステムなどがあり、コミュニティのテクニカルサポートの効率化を目指しています。
機能一覧
- 会話型Q&Aエージェント設定システムプロンプト、名前、アバター、オープナーなど、ボットの設定をオートコンプリートします。
- セルフホスト展開プログラムデータのセキュリティとプライバシーを確保するため、AWSとローカルでの展開をサポートします。
- オールインワン・アプリケーションSDK公式サイトやプロジェクトに簡単に統合でき、さまざまな統合方法をサポートします。
- 知識の自動入力GitHubのドキュメントやissueをボット用のナレッジベースとして自動リポジトリ。
- マルチプラットフォームの統合公式ウェブサイトへの対話アプリSDK統合、GitHubリポジトリへのGitHub APPワンクリックインストールをサポートします。
- プロジェクト管理サポートプロジェクトクエリー、返信ディスカッション、PRサマリー、コードレビュー、課題管理などをサポートします。
ヘルプの使用
設置プロセス
- セルフホストデプロイメント::
- ローカル・スタートアップ・サービス::
- PeterCatリポジトリをローカルにクローンする。
- 環境変数を設定し、必要な変数がすべて設定されていることを確認する。
- うごきだす
docker-compose up
サービスを開始する。
- AWSへのデプロイ::
- AWS関連の環境変数を設定する。
- AWS CLIを使用してサービスをデプロイし、すべてのリソースが正しく構成されていることを確認します。
- GitHub APPのインストール::
- GitHubリポジトリにPeterCat APPをインストールし、リポジトリへのアクセスを認証します。
- PeterCatサービスに正しく接続するために、APPの設定を行います。
使用ガイドライン
- スマートな回答ボットの作成::
- PeterCatコンソールにGitHubリポジトリのアドレスまたは名前を入力します。
- プロンプト、名前、アバターなど、ボットの設定が自動的に生成されます。
- 設定完了後、ロボットは自動的に関連する技術サポートリクエストの作業を開始します。
- ナレッジリポジトリ::
- ボットが作成されると、関連するすべてのGitHubドキュメントと課題が自動的にレポーティングされます。
- ユーザーはナレッジベースのコンテンツをコンソールで閲覧・管理し、ボットによる回答の正確性と適時性を確保することができます。
- マルチプラットフォームの統合::
- Dialogue App SDK を使用して、ボットを公式ウェブサイトまたはプロジェクトに統合します。
- PeterCat APPをGitHubリポジトリにインストールすれば、ワンクリックで統合できます。
- プロジェクト管理サポート::
- PeterCatコンソールでは、プロジェクトのステータスの確認、ディスカッションへの返信、PRサマリーの表示、コードレビューの実行ができます。
- 課題のチェック、課題の提起、課題への返信など、課題管理をサポート。
詳しい操作手順
- 環境変数の設定::
- ある
.env.local
ファイルでクライアントの環境変数を設定する。next_public_api_domain
. - ある
環境
ファイルでサーバー環境変数を設定する。API_URL
そしてWEB_URL
その他
- ある
- サービス開始::
- うごきだす
docker-compose up
ローカルサービスを開始する。 - すべてのサービスが稼働していることを確認する。
http://localhost:3000
コンソールを見る。
- うごきだす
- 知識ベースの管理::
- コンソールで受信文書とissueを表示します。
- ナレッジベースのコンテンツを手動で追加または更新し、ボットによる回答の正確性を確保する。
- 公式ウェブサイトへの統合::
- Dialogue App SDK を使用して、ボットを公式ウェブサイトまたはプロジェクトに統合します。
- PeterCatサービスに正しく接続できるようにSDKの設定を行います。