Skip to content

Commit 511e90f

Browse files
HarshCasperHarshCasper
authored
fix some documentation (#14)
1 parent 940a571 commit 511e90f

File tree

1 file changed

+5
-19
lines changed

1 file changed

+5
-19
lines changed

‎README.md‎

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Key | Value |
44
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
55
| Environment | <img src="https://img.shields.io/badge/LocalStack-deploys-4D29B4.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAKgAAACoABZrFArwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAALbSURBVHic7ZpNaxNRFIafczNTGIq0G2M7pXWRlRv3Lusf8AMFEQT3guDWhX9BcC/uFAr1B4igLgSF4EYDtsuQ3M5GYrTaj3Tmui2SpMnM3PlK3m1uzjnPw8xw50MoaNrttl+r1e4CNRv1jTG/+v3+c8dG8TSilHoAPLZVX0RYWlraUbYaJI2IuLZ7KKUWCisgq8wF5D1A3rF+EQyCYPHo6Ghh3BrP8wb1en3f9izDYlVAp9O5EkXRB8dxxl7QBoNBpLW+7fv+a5vzDIvVU0BELhpjJrmaK2NMw+YsIxunUaTZbLrdbveZ1vpmGvWyTOJToNlsuqurq1vAdWPMeSDzwzhJEh0Bp+FTmifzxBZQBXiIKaAq8BBDQJXgYUoBVYOHKQRUER4mFFBVeJhAQJXh4QwBVYeHMQJmAR5GCJgVeBgiYJbg4T8BswYPp+4GW63WwvLy8hZwLcd5TudvBj3+OFBIeA4PD596nvc1iiIrD21qtdr+ysrKR8cY42itCwUP0Gg0+sC27T5qb2/vMunB/0ipTmZxfN//orW+BCwmrGV6vd63BP9P2j9WxGbxbrd7B3g14fLfwFsROUlzBmNM33XdR6Meuxfp5eg54IYxJvXCx8fHL4F3w36blTdDI4/0WREwMnMBeQ+Qd+YC8h4g78wF5D1A3rEqwBiT6q4ubpRSI+ewuhP0PO/NwcHBExHJZZ8PICI/e73ep7z6zzNPwWP1djhuOp3OfRG5kLROFEXv19fXP49bU6TbYQDa7XZDRF6kUUtEtoFb49YUbh/gOM7YbwqnyG4URQ/PWlQ4ASllNwzDzY2NDX3WwioKmBgeqidgKnioloCp4aE6AmLBQzUExIaH8gtIBA/lFrCTFB7KK2AnDMOrSeGhnAJSg4fyCUgVHsolIHV4KI8AK/BQDgHW4KH4AqzCQwEfiIRheKKUAvjuuu7m2tpakPdMmcYYI1rre0EQ1LPo9w82qyNziMdZ3AAAAABJRU5ErkJggg=="> <img src="https://img.shields.io/badge/AWS-deploys-F29100.svg?logo=amazon"> |
6-
| Services | DynamoDB, Lambda, Cognito, API Gateway, S3, IAM, Cloudfront |
6+
| Services | DynamoDB, Lambda, Cognito, API Gateway, S3, IAM, Cloudfront |
77
| Integrations | CDK, AWS SDK for JavaScript |
88
| Categories | Serverless; |
99
| Level | Beginner |
@@ -37,7 +37,7 @@ We are using the following AWS services and their features to build our infrastr
3737
- [CDK](https://docs.localstack.cloud/user-guide/integrations/aws-cdk/) with the [`cdklocal`](https://www.npmjs.com/package/aws-cdk-local) wrapper.
3838
- [Node.js](https://nodejs.org/en/download/) with `yarn` package manager.
3939

40-
Start LocalStack Pro with the `LOCALSTACK_AUTH_TOKEN` or `LOCALSTACK_API_KEY` pre-configured:
40+
Start LocalStack Pro with the `LOCALSTACK_AUTH_TOKEN` pre-configured:
4141

4242
```shell
4343
export LOCALSTACK_AUTH_TOKEN=<your-auth-token>
@@ -135,17 +135,13 @@ make deploy-frontend
135135

136136
### View the frontend
137137

138-
Access the cloudfront distribution by fetching its id with the following command:
138+
To start the frontend locally, run the following command:
139139

140140
```shell
141-
awslocal cloudfront list-distributions
141+
yarn start:frontend
142142
```
143143

144-
with the Id of the distribution, simply open the following URL:
145-
146-
```shell
147-
http://localhost:4566/cloudfront/<distribution-id>
148-
```
144+
You'll see the URL to access the frontend in the output of the `yarn start:frontend` command
149145

150146
### Testing the web application
151147

@@ -163,16 +159,6 @@ You can click on **Create** and see the note added to the list of notes:
163159

164160
You can further edit, delete, and view the notes.
165161

166-
### Starting the frontend locally
167-
168-
To start the frontend locally, run the following command:
169-
170-
```shell
171-
yarn start:frontend
172-
```
173-
174-
You'll see the URL to access the frontend in the output of the `yarn start:frontend` command
175-
176162
### GitHub Action
177163

178164
This application sample hosts an example GitHub Action workflow that starts up LocalStack, builds the Lambda functions, and deploys the infrastructure on the runner. You can find the workflow in the `.github/workflows/main.yml` file. To run the workflow, you can fork this repository and push a commit to the `main` branch.

0 commit comments

Comments
 (0)