The stack uses github actions, but for local development, follow the below guide.
The AWS Cloud Development Kit (CDK) is used for deploying cloud infrastructure.
-
Install AWS CDK globally:
npm install -g aws-cdk
-
Set up AWS credentials if not already configured (using AWS CLI or environment variables).
-
Bootstrap your AWS environment (only required once per AWS account/region):
This step sets up a special S3 bucket that CDK needs to deploy resources.
cdk bootstrap
-
Navigate to the CDK project directory:
cd cdk -
Update the configuration:
- Open
cdk/config/config.sample.json. - Fill in the required secrets and environment-specific details.
- Save it as
config.jsonin the same directory.
- Open
-
Install CDK dependencies inside
cdk/if not already done:npm install
-
Deploy the CDK stack:
cdk deploy
The deployment will show a list of changes and ask for confirmation — type
yto proceed.
- Make sure your AWS CLI is configured properly (
aws configure). - CDK apps are region-specific; ensure you're using the correct AWS region.
- If you change config values later, re-run
cdk deployto update the deployed resources.