Skip to content

Commit

Permalink
update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshCasper committed Dec 2, 2024
1 parent 97086a0 commit 42ce773
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
<!-- ### CDK (AWS)
To deploy the application to AWS, ensure your account is bootstraped via `cdk bootstrap` and then run
```bash
AWS_CMD=aws CDK_CMD=cdk bash ./bin/deploy_cdk.sh
```
``` -->

### 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`

Expand Down

0 comments on commit 42ce773

Please sign in to comment.