Skip to main content

Quick Start

Spin up your first service with the Nx CDK Plugin in minutes.

1) Generate a service preset​

Use one of the presets to scaffold infra. For example, an Event Service:

nx g @mhshahzad/nx-cdk-deploy:preset --name=orders --preset=event-service

This creates an Nx project with CDK stacks and opinionated resources.

2) Configure environments​

Edit cdk.json or the generated config under your project to set account/region and env-specific values.

See: docs/docs/configuration/environment-variables.md and docs/docs/configuration/project-config.md.

3) Deploy​

nx deploy orders --configuration=dev

The deploy executor synthesizes and deploys the CDK stack to the selected environment.

4) Verify​

  • Check the output for stack names and endpoints
  • Visit AWS Console (CloudFormation, Lambda, API Gateway, SQS/SNS, DynamoDB, S3 depending on preset)

5) Next steps​