Skip to content

Commit 9045831

Browse files
authored
Updates to README.md (#82)
1 parent 8f08370 commit 9045831

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,25 @@ you'll be given a list of supported frameworks to start with.
6161
firebase init hosting
6262
```
6363

64+
You should see the "source" option in your `firebase.json` rather than the traditional "public". This points to the
65+
root directory of your application's source code, relative to your `firebase.json`.
66+
67+
```json
68+
{
69+
"hosting": {
70+
"source": ".",
71+
"ignore": [
72+
"firebase.json",
73+
"**/.*",
74+
"**/node_modules/**"
75+
],
76+
"frameworksBackend": {
77+
"region": "us-central1"
78+
}
79+
}
80+
}
81+
```
82+
6483
## Serve locally
6584

6685
You can test your integration locally by following these steps:
@@ -72,8 +91,33 @@ You can test your integration locally by following these steps:
7291

7392
When you're ready to share your changes with the world, deploy your app to your live site:
7493

75-
1. Run `firebase deploy` from the terminal.
76-
2. Check your website on: `SITE_ID.web.app` or `PROJECT_ID.web.app` (or your custom domain, if you set one up)
94+
1. Run `firebase deploy` from the terminal. This will build your application, detirmine if a backend is needed, and if so build and deploy a Cloud Function for you.
95+
3. Check your website on: `SITE_ID.web.app` or `PROJECT_ID.web.app` (or your custom domain, if you set one up)
96+
97+
## Configuring your backend
98+
99+
In your `firebase.json` you can alter the configuration of the code-generated Cloud Function by editing the "frameworksBackend"
100+
option. "frameworksBackend" takes the same options as [firebase-functions/v2/https.httpsOptions](https://firebase.google.com/docs/reference/functions/2nd-gen/node/firebase-functions.https.httpsoptions)
101+
though JSON-serializable. E.g,
102+
103+
104+
```json
105+
{
106+
"hosting": {
107+
"source": ".",
108+
"ignore": [
109+
"firebase.json",
110+
"**/.*",
111+
"**/node_modules/**"
112+
],
113+
"frameworksBackend": {
114+
"region": "us-central1",
115+
"minInstances": 1,
116+
"maxInstances": 10
117+
}
118+
}
119+
}
120+
```
77121

78122
# Contributors
79123

0 commit comments

Comments
 (0)