You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ App Hosting provides configuration-free build and deploy support for Web apps de
7
7
* Next.js 13+
8
8
* Angular 17.2+
9
9
10
-
This repo holds the code for the adapters that enable support for these frameworks. At a high level these adapters transform frameowkr specific configurations into an output bundle spec that App Hosting is able to process and configure frameworks support. For more information see our [documentation](https://firebase.google.com/docs/app-hosting/about-app-hosting#frameworks)
10
+
This repo holds the code for the adapters that enable support for these frameworks. At a high level these adapters transform framework specific configurations into an [output bundle spec](#app-hosting-output-bundle) that App Hosting is able to process and configure frameworks support. For more information see our [Framework integration](https://firebase.google.com/docs/app-hosting/about-app-hosting#frameworks).
11
11
12
12
## App Hosting output bundle
13
13
@@ -29,7 +29,7 @@ The output bundle all lives inside a single file:
29
29
30
30
As long as this file exists and follows the schema App Hosting will be able to process the build properly.
31
31
32
-
The schema can also be found in <https://github.com/FirebaseExtended/firebase-framework-tools/blob/main/packages/%40apphosting/common/src/index.ts#L4>
32
+
The schema can also be found in [source](https://github.com/FirebaseExtended/firebase-framework-tools/blob/main/packages/%40apphosting/common/src/index.ts#L4)
33
33
34
34
```typescript
35
35
interfaceOutputBundle {
@@ -68,7 +68,7 @@ interface EnvVarConfig {
68
68
69
69
| Field | Type | Description |
70
70
| ---------- | ------- | - |
71
-
| runCommand | string |Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace.This should be the productionized version of the server start command. |
71
+
| runCommand | string |Command to start the server (e.g. "node dist/index.js"). Assume this command is run from the root dir of the workspace.This should be the productionized version of the server start command. |
72
72
| environmentVariables| EnvVarConfig[]| Environment variables present in the server execution environment.|
73
73
| concurrency | number | The maximum number of concurrent requests that each server instance can receive.|
74
74
| cpu | number |The number of CPUs used in a single server instance. |
@@ -79,7 +79,7 @@ interface EnvVarConfig {
79
79
| EnvVarConfig.value | string |Value associated with the environment variable |
80
80
| EnvVarConfig.availability | RUNTIME | Where the variable will be available. For now this will always be RUNTIME |
81
81
82
-
Many of these fields are shared with apphosting.yaml as well so see [our documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
82
+
Many of these fields are shared with apphosting.yaml. See the [runConfig reference documentation](https://firebase.google.com/docs/reference/apphosting/rest/v1beta/projects.locations.backends.builds#runconfig) for additional context.
83
83
84
84
### Metadata
85
85
@@ -100,7 +100,7 @@ interface Metadata {
100
100
| framework | string | Name of the framework that is being supported|
101
101
| frameworkVersion | string |Version of the framework that is being supported |
102
102
103
-
Putting this all together a sample bundle.yaml would look as follows:
103
+
Here is a sample bundle.yaml file putting all this together:
104
104
105
105
```
106
106
> cat .apphosting/bundle.yaml
@@ -128,4 +128,4 @@ metadata:
128
128
129
129
```
130
130
131
-
As long as you have the bundle.yaml in this format, App Hosting will be able to deploy any server side rendered framework.
131
+
As long as you have the bundle.yaml in this format, App Hosting will be able to deploy any framework that supports server side rendering.
0 commit comments