Skip to content

Commit 47ba6e0

Browse files
committed
chore: add readme for example
1 parent 5b1014b commit 47ba6e0

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Then, the extracted directories will be located as the following:
5656
└── module1 # extracted module1 assets
5757
```
5858

59-
Please check https://github.com/tmokmss/deploy-time-build/tree/main/example for a complete example.
59+
Please check [example directory](./example/) for a complete example.
6060

6161
## Why do we need this construct?
6262
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.

example/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
## How to Deploy
22
```sh
3-
# Assume current direcotry is the example directory
3+
# Assume current directory is the example directory
44
cd ../src/lambda/nodejs-build
55
npm ci
66
npm run build
77
cd -
88
npx cdk deploy
99
```
10+
11+
## Description
12+
After a successfull deployment, you will get a CloudFront URL from the stack output.
13+
14+
![demo](../imgs/demo.png)
15+
16+
You can see the API endpoint is successfully injected to the sample frontend app.

imgs/demo.png

49.2 KB
Loading

0 commit comments

Comments
 (0)