Skip to content

Commit 1fcb98e

Browse files
committed
chore: readme updated
1 parent b3c3862 commit 1fcb98e

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

typescript/quicksight/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,23 @@
1717

1818
This project demonstrates how to set up Amazon Quicksight. It will set up a S3 Bucket, import some test data and makes it available as a datasource to quicksight.
1919

20+
With this setup you can create analysis in the console to view e.g. the world-population data:
21+
world-population.csv file in data directory taken from https://data.worldbank.org/indicator/SP.POP.TOTL
22+
License: CC BY-4.0
23+
24+
## Build
25+
26+
To build this app, you need to be in this example's root folder. Then run the following:
27+
28+
```bash
29+
npm install -g aws-cdk
30+
npm install
31+
npm run build
32+
```
33+
2034
## Deploy
2135

22-
1. Create a quicksight account [here](https://docs.aws.amazon.com/quicksight/latest/user/signing-up.html).
36+
1. Create a quicksight account [by following these instructions](https://docs.aws.amazon.com/quicksight/latest/user/signing-up.html).
2337
2. Use the arn of the quicksight account and pass it to cdk using a context `cdk deploy --context quicksightAccountArn=<arn>`
2438

2539
## Useful commands
@@ -30,6 +44,3 @@ This project demonstrates how to set up Amazon Quicksight. It will set up a S3 B
3044
* `npx cdk deploy` deploy this stack to your default AWS account/region
3145
* `npx cdk diff` compare deployed stack with current state
3246
* `npx cdk synth` emits the synthesized CloudFormation template
33-
34-
world-population.csv file in data directory taken from https://data.worldbank.org/indicator/SP.POP.TOTL
35-
License: CC BY-4.0

0 commit comments

Comments
 (0)