RevAI Concierge

RevAI Conciergeは、Googleレビュー管理とAI返信生成機能を提供するSaaSアプリケーションです。 ビジネスオーナーやマーケティング担当者が、顧客レビューを効率的に管理し、高品質な返信を自動生成することができます。

主な機能

• Googleレビュー連携: 複数店舗のGoogleレビューを一元管理
• AI返信生成: OpenAI APIを活用した高品質な返信文の自動生成
• 返信テンプレート: カスタマイズ可能な返信テンプレートの管理
• 分析ダッシュボード: レビュー評価や返信率のグラフィカルな分析
• 通知システム: 新着・低評価レビューのメール通知
• サブスクリプション管理: Stripe連携による複数プラン提供

技術スタック

• フロントエンド: Next.js 14, React 18, TypeScript, Material UI, Tailwind CSS
• バックエンド: Next.js API Routes, Express.js
• データベース: Supabase (PostgreSQL)
• 認証: Supabase Auth, Google OAuth 2.0, MFA (2FA)
• 決済: Stripe
• AI: OpenAI (GPT-4)
• メール: Nodemailer
• データ可視化: Chart.js
• 監視: Sentry, カスタムロガー
• テスト: Jest, Playwright

開発環境のセットアップ

前提条件

• Node.js 16.x以上
• npm 8.x以上
• Supabaseアカウント
• OpenAIアカウント
• Stripeアカウント

インストール手順

1. リポジトリをクローン

git clone https://github.com/yourusername/revai-concierge.git
cd revai-concierge

2. 依存パッケージをインストール

npm install

3. 環境変数を設定 .env.localファイルを作成し、必要な環境変数を設定します。

詳細な環境変数の説明はdocs/ENV_VARIABLES.mdを参照してください。

必須環境変数:

# Supabase設定
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_SERVICE_ROLE_KEY=your_supabase_service_role_key

# OpenAI設定
OPENAI_API_KEY=your_openai_api_key

# Stripe設定
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key
STRIPE_SECRET_KEY=your_stripe_secret_key
STRIPE_WEBHOOK_SECRET=your_stripe_webhook_secret

# Google OAuth設定
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
NEXT_PUBLIC_APP_URL=http://localhost:3000

環境変数のバリデーションを実行：

npm run validate-env

4. 開発サーバーを起動

npm run dev

5. ブラウザでhttp://localhost:3000にアクセス

データベース構造

Supabaseで以下のテーブルを作成する必要があります：

• tenants: テナント情報
• users: ユーザー情報
• locations: 店舗情報
• reviews: レビュー情報
• replies: 返信情報
• reply_templates: 返信テンプレート
• subscriptions: サブスクリプション情報
• payments: 支払い情報
• usage_metrics: 使用量メトリクス
• notification_settings: 通知設定
• notification_logs: 通知ログ

詳細なスキーマはdocs/database.mdを参照してください。

本番デプロイ

詳細なデプロイ手順はdocs/deployment.mdを参照してください。

Vercelへのデプロイ

1. Vercelにアカウントを作成
2. GitHubリポジトリと連携
3. 環境変数を設定（docs/ENV_VARIABLES.mdを参照）
4. データベースマイグレーションを実行（docs/DATABASE_MIGRATION.mdを参照）
5. デプロイ

デプロイ前のチェックリスト

• 環境変数のバリデーション（npm run validate-env）
• ビルドの成功確認（npm run build）
• テストの実行（npm test）
• E2Eテストの実行（npx playwright test）
• データベースマイグレーションの準備
• RLSポリシーの確認

テスト

# 単体テストを実行
npm test

# テストカバレッジレポートを生成
npm run test:coverage

# E2Eテストを実行
npx playwright test

# E2Eテストレポートを表示
npx playwright show-report

詳細なテスト情報はdocs/TEST_COVERAGE.mdを参照してください。

監視とアラート

アプリケーションには以下の監視機能が実装されています：

• エラートラッキング: Sentry統合
• パフォーマンス監視: レスポンスタイムの記録と警告
• ヘルスチェック: /api/healthエンドポイント
• ログ管理: 構造化ログと機密情報フィルタリング

詳細はdocs/MONITORING_AND_ALERTING.mdを参照してください。

ドキュメント

• セットアップガイド
• デプロイメントガイド
• APIリファレンス
• 環境変数リファレンス
• セキュリティガイド
• 監視とアラート
• パフォーマンステスト
• テストカバレッジ

ライセンス

MIT

お問い合わせ

サポートやフィードバックはsupport@example.comまでお願いします。