Skip to content

Commit 0633850

Browse files
authored
clarify yarn start instructions
1 parent f8efdfe commit 0633850

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,19 @@ All functions are compiled with webpack using the Babel Loader, so you can use m
1414

1515
Before developing, clone the repository and run `yarn` from the root of the repo to install all dependencies.
1616

17-
### Run the functions dev server
17+
### Option 1: Starting both servers at once
18+
19+
Most people should be able to get up and running just by running:
20+
21+
```bash
22+
yarn start
23+
```
24+
25+
This uses [npm-run-all](https://github.com/mysticatea/npm-run-all#readme) to run the functions dev server and app dev server concurrently.
26+
27+
### Option 2: Start each server individually
28+
29+
**Run the functions dev server**
1830

1931
From inside the project folder, run:
2032

@@ -26,7 +38,7 @@ This will open a local server running at `http://localhost:9000` serving your La
2638

2739
You can then access your functions directly at `http://localhost:9000/{function_name}`, but to access them with the app, you'll need to start the app dev server. Under the hood, this uses `react-scripts`' [advanced proxy feature](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#configuring-the-proxy-manually) with the `setupProxy.js` file.
2840

29-
### Run the app dev server
41+
**Run the app dev server**
3042

3143
While the functions server is still running, open a new terminal tab and run:
3244

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy