Hivechat

🚀 HiveChatシステムのREADME

HiveChatシステムは、チャット機能を提供するシステムです。このドキュメントでは、HiveChatシステムをローカル環境とVercelプラットフォームにインストールおよびデプロイする方法、ならびにサードパーティログインの設定方法について説明します。

🚀 クイックスタート

ローカル環境でのインストール

📦 1. PostgreSQLデータベースのインストール

• PostgreSQLをダウンロードしてインストールします（推奨バージョン：12以上）。
• 新しいデータベースを作成します（例：hivechat）。
• 以下の環境変数を .env ファイルに記入します。

DATABASE_URL=postgres://username:password@localhost/hivechat

📦 2. 環境変数の設定

プロジェクトのルートディレクトリに .env ファイルを作成し、以下の内容を追加します（実際の値に置き換えてください）。

# データベース接続URL
DATABASE_URL=postgres://username:password@localhost/hivechat

# 暗号化キー
AUTH_SECRET=hclqD3nBpMphLevxGWsUnGU6BaEa2TjrCQ77weOVpPg=

# 管理者認証コード
ADMIN_CODE=22113344

# 本番環境のドメイン（実際のドメインに合わせて記入）
NEXTAUTH_URL=http://localhost:3000

# メールログインのスイッチ
EMAIL_AUTH_STATUS=ON

# サードパーティログインの設定（実際の状況に合わせて記入）
FEISHU_AUTH_STATUS=OFF
FEISHU_CLIENT_ID=cli_xxxxxxxxxxxxxxxx
FEISHU_CLIENT_SECRET=xxxxxxxxHOEWIoE7eDc1Lhc0042OXXXX

WECOM_AUTH_STATUS=OFF
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX

DINGTALK_AUTH_STATUS=OFF
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX

📦 3. システムの起動

ターミナルで以下のコマンドを実行します。

npm install
npm run dev

起動が完了したら、http://localhost:3000/setup にアクセスして管理者アカウントを設定します。

Vercelプラットフォームでのデプロイ

📦 1. Neonデータベースの作成

• Vercelコンソールにログインし、上部のナビゲーションバーで「Storage」タブを選択し、「Create Database」をクリックします。
• 「Neon (Serverless Postgres)」を選択して作成を完了します。

📦 2. 環境変数の設定

プロジェクト設定で以下の環境変数を記入します（実際の状況に合わせて記入してください）。

# データベース接続URL（Neonコンソールから取得）
DATABASE_URL=postgres://postgres:password@localhost/hivechat

# 暗号化キー
AUTH_SECRET=hclqD3nBpMphLevxGWsUnGU6BaEa2TjrCQ77weOVpPg=

# 管理者認証コード
ADMIN_CODE=22113344

# 本番環境のドメイン（実際のドメインに合わせて記入）
NEXTAUTH_URL=http://localhost:3000

# メールログインのスイッチ
EMAIL_AUTH_STATUS=ON

# サードパーティログインの設定（実際の状況に合わせて記入）
FEISHU_AUTH_STATUS=OFF
FEISHU_CLIENT_ID=cli_xxxxxxxxxxxxxxxx
FEISHU_CLIENT_SECRET=xxxxxxxxHOEWIoE7eDc1Lhc0042OXXXX

WECOM_AUTH_STATUS=OFF
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX

DINGTALK_AUTH_STATUS=OFF
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX

📦 3. システムのデプロイ

上記の設定が完了したら、コードをリポジトリにプッシュしてVercelの自動デプロイをトリガーします。

🔧 サードパーティログインの設定説明

1. 微信企業版（WECOM）

• 微信企業版の管理画面にログインし、アプリを作成して Client ID と Client Secret を取得します。
• これらの値を環境変数に記入します。

WECOM_AUTH_STATUS=ON
WECOM_CLIENT_ID=ww728c371c2fXXXXXX
WECOM_AGENT_ID=100XXXX
WECOM_CLIENT_SECRET=H-7J4jzG0m1axpXLGshaCDlMOZxdjvkX6bIVLuXXXXXX

2. 飛書（DINGTALK）

• 飛書の開発者ポータルにログインし、アプリを作成して Client ID と Client Secret を取得します。
• これらの値を環境変数に記入します。

DINGTALK_AUTH_STATUS=ON
DINGTALK_CLIENT_ID=dingpcfi2kpuplXXXXXX
DINGTALK_CLIENT_SECRET=3vk9-VFCExNckqNUk_CL2F-HEgz7qGN-BimH0lZ1g_an2lnkk6XXXXXX

📄 注意事項

⚠️ 重要提示

• すべての環境変数の値が正しいことを確認してください。
• データベースを定期的にバックアップして、データの損失を防いでください。
• デプロイが完了したら、各機能（管理者ログイン、サードパーティログインなど）をテストすることをおすすめします。

問題が発生した場合は、公式ドキュメント を参照するか、技術サポートに連絡してください。