Skip to content

Commit a53b973

Browse files
committed
Tweaking readme
1 parent c689e59 commit a53b973

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,30 @@ This repo is for the frontend React app that we build over the course of the tut
66

77
#### Steps
88

9-
This branch in the repo is related to one of the steps in the guide. Here is an index of the various steps in order.
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.
1010

1111
- [Initialize the Frontend Repo](../../tree/initialize-the-frontend-repo)
1212
- [Configure AWS Amplify](../../tree/configure-aws-amplify)
1313
- [Redirect on Login](../../tree/redirect-on-login)
1414
- [Create a Build Script](../../tree/create-a-build-script)
1515

16+
#### Usage
17+
18+
This project is created using [Create React App](https://github.com/facebookincubator/create-react-app).
19+
20+
To use this repo locally, start by cloning it and installing the NPM packages.
21+
22+
``` bash
23+
$ git clone https://github.com/AnomalyInnovations/serverless-stack-demo-client
24+
$ npm install
25+
```
26+
27+
Run it locally.
28+
29+
``` bash
30+
$ npm run start
31+
```
32+
1633
---
1734

1835
This repo is maintained by [Anomaly Innovations](https://anoma.ly); makers of [Seed](https://seed.run) and [Serverless Stack](https://serverless-stack.com).

0 commit comments

Comments
 (0)