diff --git a/README.md b/README.md index c7d653c..ea3282d 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,8 @@ EXTRA_CORS_ALLOWED_ORIGINS='*' DISABLE_CUSTOM_CORS_APIGATEWAY=1 DISABLE_CUSTOM_C If you run into specific CORS issues, disable it using a [browser extension](https://webextension.org/listing/access-control.html). ## Local Deployment -### awslocal + +### AWS CLI (`awslocal`) To deploy the app locally, run the following command: @@ -62,17 +63,18 @@ API Gateway Endpoint: http://localhost:4566/_aws/execute-api/4xu5emxibf/test Navigate to the CloudFront URL to check out the app. The script would also seed some quiz data and user data to make local testing easier. -### cdk + -### cdklocal +### CDK Local Alternatively the application can be deployed to LocalStack via `cdklocal`, our wrapper around the AWS CDK. Perform the following steps: + 1. Bootstrap LocalStack: `cd cdk && cdklocal bootstrap` 2. Deploy the application: `AWS_CMD=awslocal CDK_CMD=cdklocal bash ./bin/deploy_cdk.sh`