Skip to content

Commit 046e808

Browse files
committed
Update README with CDK instructions
1 parent 4d1c2a3 commit 046e808

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ EXTRA_CORS_ALLOWED_ORIGINS='*' DISABLE_CUSTOM_CORS_APIGATEWAY=1 DISABLE_CUSTOM_C
4646
If you run into specific CORS issues, disable it using a [browser extension](https://webextension.org/listing/access-control.html).
4747

4848
## Local Deployment
49+
### awslocal
4950

5051
To deploy the app locally, run the following command:
5152

@@ -61,6 +62,14 @@ API Gateway Endpoint: http://localhost:4566/_aws/execute-api/4xu5emxibf/test
6162

6263
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.
6364

65+
### cdklocal
66+
67+
Alternatively the application can be deployed to LocalStack via `cdklocal`, our wrapper around the AWS CDK. Perform the following steps:
68+
1. Bootstrap LocalStack: `cd cdk && cdklocal bootstrap`
69+
2. Deploy the application: `AWS_CMD=awslocal CDK_CMD=cdklocal bash ./bin/deploy_cdk.sh`
70+
71+
_Note: while the core quiz application works with CDK, additional features have not been implemented yet._
72+
6473
## Local Testing
6574

6675
To run an automated test suite against the local deployment, run the following command:

0 commit comments

Comments
 (0)