PropCloud デプロイガイド

PropCloud のローカル開発環境セットアップから AWS 本番環境へのデプロイまでを解説します。

ローカル開発環境セットアップ

前提条件

セットアップ手順

# 1. リポジトリをクローン
git clone https://github.com/gmaeshima-blip/real_estate.git
cd real_estate

# 2. Docker で依存サービスを起動
docker compose up -d

# 3. 依存パッケージのインストール
npm install

# 4. 環境変数ファイルの作成
cp .env.example .env.local

# 5. Prisma クライアント生成 & スキーマ反映
npx prisma generate
npx prisma db push

# 6. シードデータの投入（任意）
npm run db:seed

# 7. 開発サーバーの起動
npm run dev

http://localhost:3000 でアプリケーションにアクセスできます。

便利なコマンド

# Prisma Studio（DB GUI）を起動
npm run db:studio

# マイグレーション作成・実行
npm run db:migrate

# テスト実行
npm run test

# カバレッジ計測
npm run test:coverage

# リント
npm run lint

# コード整形
npm run format

Docker Compose 構成

開発用の `docker-compose.yml` は以下のサービスを提供します。

構成例

version: "3.8"

services:
  postgres:
    image: postgres:16-alpine
    environment:
      POSTGRES_USER: propcloud
      POSTGRES_PASSWORD: propcloud_dev
      POSTGRES_DB: propcloud_dev
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U propcloud"]
      interval: 10s
      timeout: 5s
      retries: 5

  redis:
    image: redis:7-alpine
    ports:
      - "6379:6379"
    volumes:
      - redis_data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  postgres_data:
  redis_data:

環境変数一覧

`.env.example` に定義される環境変数の一覧です。

データベース

Redis

認証

アプリケーション

ストレージ

メール

監視

AWS 環境構成

本番環境は AWS 上に以下の構成でデプロイされます。

アーキテクチャ概要

                    ┌──────────────────┐
                    │   Route 53       │
                    │  (DNS)           │
                    └────────┬─────────┘
                             │
                    ┌────────▼─────────┐
                    │   CloudFront     │
                    │  (CDN)           │
                    └────────┬─────────┘
                             │
                    ┌────────▼─────────┐
                    │   ALB            │
                    │  (ロードバランサー) │
                    └────────┬─────────┘
                             │
              ┌──────────────┼──────────────┐
              │              │              │
     ┌────────▼───┐ ┌───────▼────┐ ┌───────▼────┐
     │  ECS Task  │ │  ECS Task  │ │  ECS Task  │
     │  (Fargate) │ │  (Fargate) │ │  (Fargate) │
     └────────┬───┘ └───────┬────┘ └───────┬────┘
              │              │              │
              └──────────────┼──────────────┘
                             │
              ┌──────────────┼──────────────┐
              │                             │
     ┌────────▼─────────┐        ┌─────────▼────────┐
     │   RDS             │        │  ElastiCache      │
     │  (PostgreSQL 16)  │        │  (Redis 7)        │
     │   Multi-AZ        │        │  クラスターモード   │
     └──────────────────┘        └──────────────────┘

AWS サービス一覧

ネットワーク構成

セキュリティグループ

CI/CD パイプライン

概要

GitHub Actions と AWS CodePipeline を組み合わせたパイプラインを構築します。

GitHub (push/PR)
    │
    ├── GitHub Actions（CI）
    │   ├── リント（ESLint）
    │   ├── 型チェック（TypeScript）
    │   ├── ユニットテスト（Vitest）
    │   ├── E2E テスト（Playwright）
    │   └── Docker イメージビルド & ECR プッシュ
    │
    └── AWS CodePipeline（CD）
        ├── Source: ECR イメージ検知
        ├── Build: タスク定義更新
        ├── Deploy (dev): ECS Blue/Green デプロイ
        ├── Approval: 手動承認（本番のみ）
        └── Deploy (prod): ECS Blue/Green デプロイ

GitHub Actions ワークフロー

GitHub Actions CI 例

name: CI

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  lint-and-typecheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - run: npm run lint
      - run: npx tsc --noEmit

  test:
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres:16-alpine
        env:
          POSTGRES_USER: test
          POSTGRES_PASSWORD: test
          POSTGRES_DB: propcloud_test
        ports:
          - 5432:5432
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm
      - run: npm ci
      - run: npx prisma generate
      - run: npm run test:coverage
        env:
          DATABASE_URL: postgresql://test:test@localhost:5432/propcloud_test

  build:
    needs: [lint-and-typecheck, test]
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: actions/checkout@v4
      - uses: aws-actions/configure-aws-credentials@v4
        with:
          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
          aws-region: ap-northeast-1
      - uses: aws-actions/amazon-ecr-login@v2
      - run: |
          docker build -t $ECR_REGISTRY/propcloud:${{ github.sha }} .
          docker push $ECR_REGISTRY/propcloud:${{ github.sha }}

AWS CodePipeline 構成

ブルーグリーンデプロイ手順

ECS のブルーグリーンデプロイにより、ダウンタイムなしでアプリケーションを更新します。

仕組み

          ┌─────────────────────────────────┐
          │           ALB                    │
          │  リスナールール                    │
          └────────┬──────────┬──────────────┘
                   │          │
          本番リスナー(443)  テストリスナー(8443)
                   │          │
              ┌────▼────┐ ┌───▼─────┐
              │ Blue TG │ │ Green TG │
              │ (現行)   │ │ (新版)    │
              └────┬────┘ └───┬─────┘
                   │          │
              ┌────▼────┐ ┌───▼─────┐
              │ ECS     │ │ ECS     │
              │ Tasks   │ │ Tasks   │
              │ (v1.2)  │ │ (v1.3)  │
              └─────────┘ └─────────┘

デプロイフロー

1. **新バージョンのタスク起動**

- Green ターゲットグループに新バージョンの ECS タスクが起動される

- ヘルスチェック (`/api/health`) が通るまで待機

2. **テストリスナーで検証**

- テストリスナー（ポート 8443）経由で新バージョンにアクセス可能

- 自動テストまたは手動検証を実施

- 検証時間: 最大 60 分（設定可能）

3. **トラフィック切り替え**

- 本番リスナーを Green ターゲットグループに切り替え

- 全トラフィックが新バージョンに流れる

4. **旧バージョンの保持**

- 切り替え後、旧バージョン（Blue）のタスクは 60 分間保持

- 問題発生時は即座にロールバック可能

5. **旧バージョンの削除**

- 保持期間経過後、旧タスクが自動的に削除される

ロールバック手順

デプロイ後に問題が発生した場合:

# 1. CodeDeploy のデプロイメントを確認
aws deploy list-deployments \
  --application-name propcloud-app \
  --deployment-group-name propcloud-prod-dg \
  --include-only-statuses Succeeded

# 2. ロールバック（自動）
# CodeDeploy のアラーム監視により、以下の条件で自動ロールバック:
# - ヘルスチェック失敗
# - CloudWatch アラーム発火（エラー率 > 5%、レイテンシー p99 > 3s）

# 3. 手動ロールバック
aws deploy stop-deployment \
  --deployment-id <deployment-id> \
  --auto-rollback-enabled

ロールバック条件（自動）

デプロイ設定

{
  "deploymentConfig": {
    "terminationWaitTimeInMinutes": 60,
    "deploymentReadyOption": {
      "actionOnTimeout": "CONTINUE_DEPLOYMENT",
      "waitTimeInMinutes": 30
    },
    "blueGreenDeploymentConfiguration": {
      "terminateBlueInstancesOnDeploymentSuccess": {
        "action": "TERMINATE",
        "terminationWaitTimeInMinutes": 60
      }
    }
  }
}

環境別設定