Skip to content

Commit 766b3ee

Browse files
committed
Updating README
1 parent d09a69d commit 766b3ee

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,52 @@
33
[Serverless Stack](http://serverless-stack.com) is a free comprehensive guide to creating full-stack serverless applications. We create a [note taking app](http://demo.serverless-stack.com) from scratch.
44

55
This repo is for the frontend React app that we build over the course of the tutorial. You can find the repo for the backend serverless API [here](https://github.com/AnomalyInnovations/serverless-stack-demo-api). And the repo for the tutorial [here](https://github.com/AnomalyInnovations/serverless-stack-com).
6+
7+
#### Steps
8+
9+
To support the different chapters and steps of the tutorial; we use branches to represent the project codebase at the various points. Here is an index of the various chapters and branches in order.
10+
11+
- [Configure AWS Amplify](../../tree/configure-aws-amplify)
12+
- [Give Feedback While Logging In](../../tree/give-feedback-while-logging-in)
13+
- [Signup with AWS Cognito](../../tree/signup-with-aws-cognito)
14+
- [Upload a File to S3](../../tree/upload-a-file-to-s3)
15+
- [Call the List API](../../tree/call-the-list-api)
16+
- [Delete a Note](../../tree/delete-a-note)
17+
- [Redirect on Login](../../tree/redirect-on-login)
18+
- [Code Splitting in Create React App](../../tree/code-splitting-in-create-react-app)
19+
20+
#### Usage
21+
22+
This project is created using [Create React App](https://github.com/facebookincubator/create-react-app).
23+
24+
To use this repo locally, start by cloning it and installing the NPM packages.
25+
26+
``` bash
27+
$ git clone https://github.com/AnomalyInnovations/serverless-stack-demo-client
28+
$ npm install
29+
```
30+
31+
Run it locally.
32+
33+
``` bash
34+
$ npm run start
35+
```
36+
37+
To deploy, replace the following in the [`package.json`](package.json) with your S3 bucket and CloudFront distributions.
38+
39+
```
40+
"deploy": "aws s3 sync build/ s3://notes-app-client",
41+
"postdeploy": "aws cloudfront create-invalidation --distribution-id E1KTCKT9SOAHBW --paths '/*' && aws cloudfront create-invalidation --distribution-id E3MQXGQ47VCJB0 --paths '/*'",
42+
```
43+
44+
And run.
45+
46+
``` bash
47+
$ npm run deploy
48+
```
49+
50+
#### Maintainers
51+
52+
Serverless Stack is authored and maintained by Frank Wang ([@fanjiewang](https://twitter.com/fanjiewang)) & Jay V ([@jayair](https://twitter.com/jayair)). [**Subscribe to our newsletter**](http://eepurl.com/cEaBlf) for updates on Serverless Stack. Send us an [email][Email] if you have any questions.
53+
54+
[Email]: mailto:contact@anoma.ly

0 commit comments

Comments
 (0)