メインコンテンツまでスキップ

インストール

システム要件:

自動インストール​

まず、mbc-cqrs-serverless CLI を使用してプロジェクトをスキャフォールディングします。次のコマンドを実行します。これにより、新しいプロジェクト ディレクトリが作成され、そのディレクトリに初期コアの mbc-cqrs-serverless ファイルとサポート モジュールが追加され、プロジェクトの従来の基本構造が作成されます。

npm i -g @mbc-cqrs-serverless/cli
mbc new project-name

mbc-cqrs-serverless を初めて使う方は、プロジェクト構造 のドキュメントを参照して、アプリケーション内で使用できるすべてのファイルとフォルダーの概要を確認してください。

開発用サーバの実行​

  1. npm run build を実行してウォッチモードでプロジェクトをビルドします。
  2. 別のターミナルセッションを開いてnpm run offline:dockerを実行し、Dockerサービス（DynamoDB Local、MySQL、LocalStack）を起動します。
  3. MySQLが完全に起動するまで約30秒待ってから、別のターミナルを開いてnpm run migrateを実行し、RDSとDynamoDBのテーブルをマイグレーションします。
  4. 最後に npm run offline:sls コマンドを実行して serverless offline mode を実行します。
ローカル開発でのAWSクレデンシャル

ローカル開発ではLocalStackを使用してAWSサービスをエミュレートします。実際のAWSクレデンシャルは不要です — .envファイルにダミー値を設定してください：

AWS_ACCESS_KEY_ID=local
AWS_SECRET_ACCESS_KEY=local

サーバの起動が完了したら次のようなメッセージを確認する事が出来ます。

DEBUG[serverless-offline-sns][adapter]: successfully subscribed queue "http://localhost:9324/101010101010/notification-queue" to topic: "arn:aws:sns:ap-northeast-1:101010101010:MySnsTopic"
Offline Lambda Server listening on http://localhost:4000
serverless-offline-aws-eventbridge :: Plugin ready
serverless-offline-aws-eventbridge :: Mock server running at port: 4010
Starting Offline SQS at stage dev (ap-northeast-1)
Starting Offline Dynamodb Streams at stage dev (ap-northeast-1)

Starting Offline at stage dev (ap-northeast-1)

Offline [http for lambda] listening on http://localhost:3002
Function names exposed for local invocation by aws-sdk:
           * main: serverless-example-dev-main
Configuring JWT Authorization: ANY /{proxy+}

   ┌────────────────────────────────────────────────────────────────────────┐
   │                                                                        │
   │   ANY | http://localhost:3000/api/public                               │
   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
   │   ANY | http://localhost:3000/swagger-ui/{proxy*}                      │
   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
   │   ANY | http://localhost:3000/{proxy*}                                 │
   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
   │                                                                        │
   └────────────────────────────────────────────────────────────────────────┘

Server ready: http://localhost:3000 🚀

次のサービスのエンドポイントが起動します。:

セットアップの確認

Swagger UI をブラウザで開き、APIサーバーが起動していることを確認してください。利用可能なすべてのエンドポイントを含むインタラクティブなAPIドキュメントが表示されるはずです。

ローカルサービスのポート設定​

バージョンノート

ローカルポート設定機能はバージョン 1.0.26で追加されました。

他のサービス（別のMySQLインスタンスやポート3000を使用する他のアプリケーションなど）とポートが競合する場合は、.envファイルの環境変数でローカルサービスのポートを設定できます。

利用可能なポート変数​

変数デフォルトサービス
LOCAL_HTTP_PORT3000API Gateway (Serverless Offline)
LOCAL_LAMBDA_PORT3002Lambda HTTPエンドポイント
LOCAL_DYNAMODB_PORT8000DynamoDB Local
LOCAL_RDS_PORT3306MySQL (RDS)
LOCAL_S3_PORT4566LocalStack (S3)
LOCAL_SNS_PORT4002SNS
LOCAL_SQS_PORT9324SQS (ElasticMQ)
LOCAL_SQS_UI_PORT9325SQS管理画面
LOCAL_SFN_PORT8083Step Functions Local
LOCAL_COGNITO_PORT9229Cognito Local
LOCAL_APPSYNC_PORT4001AppSyncシミュレーター
LOCAL_EVENTBRIDGE_PORT4010EventBridge
LOCAL_SES_PORT8005Simple Email Service
LOCAL_DDB_ADMIN_PORT8001DynamoDB管理画面

例: ポートの変更​

API Gatewayのポートを3000から3010に、MySQLのポートを3306から3307に変更するには、.envファイルに以下を追加します：

# API Gatewayのポートを3010に変更
LOCAL_HTTP_PORT=3010

# MySQLのポートを3307に変更
LOCAL_RDS_PORT=3307

# DynamoDBのポートを9000に変更
LOCAL_DYNAMODB_PORT=9000

ポートを変更した後、すべてのサービスを再起動します：

  1. 実行中のすべてのサービス（DockerとServerless Offline）を停止
  2. npm run offline:dockerを実行してDockerサービスを再起動
  3. npm run offline:slsを実行してServerless Offlineを再起動
ヒント

ポート設定は、Docker Compose、Serverless Offline、DynamoDBストリームトリガースクリプトを含むすべての関連サービスに自動的に適用されます。.envファイルで環境変数を一度設定するだけで済みます。

注記

ローカル開発環境で npm run migrate コマンドやローカルの Cognito にログイン出来ない場合は次のコマンドを使用してファイルやフォルダーにアクセス権を設定する必要があります。

sudo chmod -R 777 ./infra-local/cognito-local
sudo chmod -R 777 ./infra-local/cognito-local/db/clients.json
sudo chmod -R 777 ./infra-local
sudo chmod -R 777 ./infra-local/docker-data/
sudo chmod -R 777 ./infra-local/docker-data/dynamodb-local

次のステップ​

ローカル環境の準備が整いました。次の順序で進めることをお勧めします：

  1. クイックスタートチュートリアル — 15分で最初のAPIエンドポイントを構築
  2. プロジェクト構成 — 生成されたファイルとフォルダの役割を理解する
  3. アーキテクチャ — フレームワークの背景にあるCQRSとイベントソーシングの概念を学ぶ
  4. バックエンド開発 — 実際の機能の実装を開始する

関連ドキュメント​