diff --git a/README.md b/README.md index 93d7d81..d69cf29 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Then, the extracted directories will be located as the following: └── module1 # extracted module1 assets ``` -Please check https://github.com/tmokmss/deploy-time-build/tree/main/example for a complete example. +Please check [example directory](./example/) for a complete example. ## Why do we need this construct? Previously, there are a few different ways to deploy frontend applications from CDK (1 and 2 below). But none is perfect with different pros and cons. This construct adds another option to deploy frontend apps. diff --git a/example/README.md b/example/README.md index 45f0bb9..8e5458a 100644 --- a/example/README.md +++ b/example/README.md @@ -1,9 +1,16 @@ ## How to Deploy ```sh -# Assume current direcotry is the example directory +# Assume current directory is the example directory cd ../src/lambda/nodejs-build npm ci npm run build cd - npx cdk deploy ``` + +## Description +After a successfull deployment, you will get a CloudFront URL from the stack output. + +![demo](../imgs/demo.png) + +You can see the API endpoint is successfully injected to the sample frontend app. diff --git a/imgs/demo.png b/imgs/demo.png new file mode 100644 index 0000000..bc15bbb Binary files /dev/null and b/imgs/demo.png differ