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

クイックスタートチュートリアル

このチュートリアルでは、最初のMBC CQRS Serverlessアプリケーションの作成方法を説明します。完了時には、ローカルで動作するAPIが完成します。

前提条件​

開始する前に、以下がインストールされていることを確認してください：

  • Node.js 20.x 以降
  • Docker と Docker Compose
  • AWS CLI（ローカル開発では実際のクレデンシャルは不要です — .envファイルにAWS_ACCESS_KEY_ID=localとAWS_SECRET_ACCESS_KEY=localを設定してください）
  • Git

ステップ1: 新規プロジェクトの作成​

MBC CQRS CLIを使用して新しいプロジェクトをスキャフォールドします：

npx @mbc-cqrs-serverless/cli new my-app
cd my-app

CLIは以下の構造でプロジェクトを作成します：

my-app/
├── src/
│   ├── main.ts
│   ├── main.module.ts
│   └── ...
├── infra-local/
│   ├── docker-compose.yml
│   └── serverless.yml
├── prisma/
│   └── schema.prisma
├── package.json
└── ...

ステップ2: 依存関係のインストール​

npm install

ステップ3: 環境設定​

環境設定ファイルをコピーし、ローカル開発用のダミーAWSクレデンシャルを設定します：

cp .env.example .env

.envを開いて以下の値が設定されていることを確認してください（LocalStackがAWSをエミュレートするため、実際のクレデンシャルは不要）：

AWS_ACCESS_KEY_ID=local
AWS_SECRET_ACCESS_KEY=local

TypeScriptアプリケーションをビルドします（サーバー起動前に必要）：

npm run build

ステップ4: ローカルインフラの起動​

Docker Composeを使用してローカル開発環境を起動します：

npm run offline:docker

以下のサービスが起動します：

  • DynamoDB Local（ポート8000）
  • MySQL（ポート3306）
  • AWSサービス用のLocalStack

ステップ5: データベースの初期化​

MySQLが完全に起動するまで約30秒待ってから、Prismaマイグレーションを実行してデータベーススキーマをセットアップします：

npm run migrate

ステップ6: 開発サーバーの起動​

新しいターミナルで、Serverless Offlineサーバーを起動します：

npm run offline:sls

APIは http://localhost:3000 で実行されています。

ステップ7: APIのテスト​

ブラウザでSwagger UIを開いてAPIを確認・テストしてください：

http://localhost:3000/swagger-ui/

Swagger UIが表示され、利用可能なエンドポイントが一覧表示されます。

最初のエンドポイントの作成​

シンプルな「Hello World」エンドポイントを作成しましょう。

コントローラーの作成​

src/hello/hello.controller.ts を新規作成します：

import { Controller, Get } from '@nestjs/common';

@Controller('hello')
export class HelloController {
  @Get()
  getHello(): string {
    return 'Hello, MBC CQRS Serverless!';
  }
}

モジュールの作成​

src/hello/hello.module.ts を新規作成します：

import { Module } from '@nestjs/common';
import { HelloController } from './hello.controller';

@Module({
  controllers: [HelloController],
})
export class HelloModule {}

モジュールの登録​

src/main.module.ts のメインモジュールにHelloModuleを追加します：

import { Module } from '@nestjs/common';
import { HelloModule } from './hello/hello.module';

@Module({
  imports: [
    // ... existing imports
    HelloModule,
  ],
})
export class MainModule {}

新しいエンドポイントのテスト​

サーバーを再起動して新しいエンドポイントをテストします：

curl http://localhost:3000/hello

Hello, MBC CQRS Serverless! と表示されます。

次のステップ​

おめでとうございます！最初のMBC CQRS Serverlessアプリケーションが完成しました。次に探索すべき内容：

よく使うコマンド​

コマンド説明
npm run offline:dockerローカルDockerサービスを起動
npm run offline:slsServerless Offlineを起動
npm run migrateデータベースマイグレーションを実行
npm run buildアプリケーションをビルド
npm run testユニットテストを実行
npm run test:e2eE2Eテストを実行

トラブルシューティング​

Dockerサービスが起動しない​

Dockerが実行中で、十分なリソースが割り当てられていることを確認してください。以下を試してください：

docker-compose -f infra-local/docker-compose.yml down
docker-compose -f infra-local/docker-compose.yml up -d

データベース接続エラー​

MySQLが完全に起動するまで数秒待ってから、再度マイグレーションを実行してください：

npm run migrate

ポートの競合​

ポート3000、3306、8000が使用中の場合は、.envファイルの環境変数でカスタムポートを設定してください：

LOCAL_HTTP_PORT=3010
LOCAL_RDS_PORT=3307
LOCAL_DYNAMODB_PORT=9000

利用可能なすべてのポート変数についてはローカルサービスのポート設定を参照してください。

関連ドキュメント​