ottomon

Ottomon: コード、ビデオ、ドキュメントを使用してチャットします

Ottomon は、あらゆる Web サイト、YouTube チャンネル、GitHub リポジトリを動的なチャットボットに簡単に変換できる強力な GenAI プラットフォームです。ユーザーエンゲージメントを強化したい場合でも、サポートを合理化したい場合でも、単に新しい可能性を探求したい場合でも、Ottomon はあなたをサポートします。

はじめる

Ottomon を使い始めるには、次の簡単な手順に従ってください。

1. リポジトリのクローンを作成する: まず、Ottomon リポジトリをローカル環境にクローン作成します。

   git clone https://github.com/vgulerianb/ottomon.git

2. 構成: Ottomon インスタンスを構成するための.envファイルを作成します。ファイルには次の変数が含まれている必要があります。

   • OPENAI_API_KEY : OpenAI の API キー。
   • NEXT_PUBLIC_SUPABASE_URL : Supabase インスタンスの URL (この目的のために、Supabase 上に新しいプロジェクトを作成します)。
   • SUPABASE_SERVICE_ROLE_KEY : Supabase インスタンスのサービス ロール キー (この目的のために、Supabase 上に新しいプロジェクトを作成します)。
   • JWT_SECRET : JWT トークンに署名するための秘密鍵。
   • SQL_CONNECTION_STRING : Supabase データベースの接続文字列 (このために Supabase 上に新しいプロジェクトを作成します)。

3. データベースの初期化: 次のコマンドを実行してデータベースを初期化し、Supabase インスタンスに必要なテーブルとデータをセットアップします。

   npx prisma db push

4. 走るオットモン：

   • Docker の使用:

     • Docker イメージをビルドします。

       docker build -t ottomon .

     • Docker コンテナを実行します。

       docker run -p 3000:3000 ottomon

   • ローカルで開始:

     • 依存関係をインストールします。

       yarn install

     • アプリケーションを構築します。

       yarn build

     • Ottomon Web アプリケーションを起動します。

       yarn start

貢献する

オットモンへの貢献を歓迎します！貢献したい場合は、次の手順に従ってください。

1. リポジトリをフォークする: まず、Ottomon リポジトリを GitHub アカウントにフォークします。

2. 新しいブランチの作成: 機能またはバグ修正用に新しいブランチを作成します (例: feature/my-new-feature )。

3. 変更を加える: ブランチ内で変更を実装します。

4. 変更をコミット: 説明的なメッセージ (「機能を追加」など) を使用して変更をコミットします。

5. ブランチにプッシュ: 変更を GitHub 上のブランチにプッシュします。

6. プル リクエストの作成: 新しいプル リクエストを作成して、Ottomon プロジェクトにレビューして含めるための変更を提案します。

Ottomon はエキサイティングな GenAI プラットフォームであり、あなたの貢献がそれをさらに良くするのに役立ちます。

---

Ottomon プロジェクトの必要に応じて、この README を自由に適応および変更してください。