Skip to content

Commit b3f6ee1

Browse files
committed
fix: update frontend README content
1 parent 26255f1 commit b3f6ee1

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

samples/contract-compliance-analysis/frontend/README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,28 @@ These extensions work together through the configured `prettier-plugin-tailwindc
2626

2727
## Setup and run
2828

29-
1. After successfully deploying your backend stack, you can easily find the information required for the next step by inspecting to Amazon API Gateway and/or Amazon CloudFormation console.
29+
1. After successfully deploying your backend stack, retrieve the required configuration values from CloudFormation outputs:
3030

31-
2. Create a `.env` file by duplicating the included `example.env` and replace the property values with the values retrieved from MainBackendStack outputs.
31+
```bash
32+
aws cloudformation describe-stacks --stack-name MainBackendStack --query "Stacks[0].Outputs[].{OutputKey:OutputKey,OutputValue:OutputValue}" --output yaml
33+
```
34+
35+
2. Create a `.env` file by duplicating the included `example.env` and replace the placeholder values with the outputs from step 1.
3236

3337
```properties
34-
VITE_AWS_REGION="<REGION_NAME>"
38+
VITE_APP_NAME="Contract Compliance Analysis"
39+
VITE_AWS_REGION="<MainBackendStack.RegionName>"
3540
VITE_AWS_ACCOUNT_ID="<AWS_ACCOUNT_ID>"
36-
VITE_COGNITO_USER_POOL_ID="<COGNITO_USER_POOL_ID>"
37-
VITE_COGNITO_USER_POOL_CLIENT_ID="<COGNITO_USER_POOL_CLIENT_ID>"
38-
VITE_COGNITO_IDENTITY_POOL_ID="<COGNITO_IDENTITY_POOL_ID>"
39-
VITE_API_GATEWAY_REST_ENDPOINT="<API_GATEWAY_REST_ENDPOINT>"
41+
VITE_COGNITO_USER_POOL_ID="<MainBackendStack.CognitoUserPoolId*>"
42+
VITE_COGNITO_USER_POOL_CLIENT_ID="<MainBackendStack.CognitoUserPoolClientId*>"
43+
VITE_COGNITO_IDENTITY_POOL_ID="<MainBackendStack.CognitoIdentityPoolId*>"
44+
VITE_API_GATEWAY_REST_ENDPOINT="<MainBackendStack.ApiGatewayRestApiEndpoint*>"
4045
VITE_API_NAME="RestAPI"
41-
VITE_S3_BUCKET_NAME="<S3_BUCKET_NAME>"
46+
VITE_S3_BUCKET_NAME="<MainBackendStack.ContractBucketName>"
4247
```
4348

49+
**Note**: Output names marked with `*` may have CDK-generated suffixes.
50+
4451
3. Install dependencies:
4552

4653
```shell
511 KB
Loading

0 commit comments

Comments
 (0)