Skip to content

Commit 42ce773

Browse files
committed
update the documentation
1 parent 97086a0 commit 42ce773

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ 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
49+
50+
### AWS CLI (`awslocal`)
5051

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

@@ -62,17 +63,18 @@ API Gateway Endpoint: http://localhost:4566/_aws/execute-api/4xu5emxibf/test
6263

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

65-
### cdk
66+
<!-- ### CDK (AWS)
6667
6768
To deploy the application to AWS, ensure your account is bootstraped via `cdk bootstrap` and then run
6869
6970
```bash
7071
AWS_CMD=aws CDK_CMD=cdk bash ./bin/deploy_cdk.sh
71-
```
72+
``` -->
7273

73-
### cdklocal
74+
### CDK Local
7475

7576
Alternatively the application can be deployed to LocalStack via `cdklocal`, our wrapper around the AWS CDK. Perform the following steps:
77+
7678
1. Bootstrap LocalStack: `cd cdk && cdklocal bootstrap`
7779
2. Deploy the application: `AWS_CMD=awslocal CDK_CMD=cdklocal bash ./bin/deploy_cdk.sh`
7880

0 commit comments

Comments
 (0)