Skip to content

Commit c9a89e2

Browse files
committed
Updates per PR feedback
1 parent a0e901e commit c9a89e2

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,38 +45,36 @@ framework.
4545
This repository is maintained by Googlers but is not a supported Firebase product. Issues here are answered by
4646
maintainers and other community members on GitHub on a best-effort basis.
4747

48-
# Enable framework-awareness
48+
## Enable framework-awareness
4949

5050
This is an experimental addon to the Firebase CLI to add web framework support, to enable it call the following:
5151

5252
```shell
5353
firebase experiments:enable webframeworks
5454
```
5555

56-
# Prerequisites
56+
## Prerequisites
5757

5858
- Firebase CLI version 10.9.1 or later (see installation instructions [here](https://firebase.google.com/docs/cli))
5959

60-
### Serve locally
60+
## Serve locally
6161

6262
You can test your integration locally by following these steps:
6363

6464
1. Run `firebase serve` from the terminal. This should build your Angular app and serve it using the Firebase CLI.
6565
2. Open your web app at the local URL returned by the CLI (usually http://localhost:5000)
6666

67-
### Deploy your app to Firebase Hosting
67+
## Deploy your app to Firebase Hosting
6868

6969
When you're ready to share your changes with the world, deploy your Angular app to your live site:
7070

7171
1. Run `firebase deploy` from the terminal.
7272
2. Check your website on: `SITE_ID.web.app` or `PROJECT_ID.web.app` (or your custom domain, if you did setup one)
7373

74-
## Guide: "Integrate Angular"
74+
## "Integrate Angular"
7575

7676
Easily deploy your Angular application to Firebase and serve dynamic content to your users.
7777

78-
## What you'll need before you begin
79-
8078
### Prerequisites
8179

8280
- Firebase CLI version 10.9.1 or later (see installation instructions [here](https://firebase.google.com/docs/cli))
@@ -112,7 +110,7 @@ Change your hosting config in `firebase.json` to have a `source` option, rather
112110
}
113111
```
114112

115-
## Serve static content
113+
### Serve static content
116114

117115
After initializing Firebase, you can serve static content with the standard deployment command:
118116

@@ -157,7 +155,7 @@ your angular.json and adding more routes:
157155
Firebase will also respect guessRoutes or a routes.txt file in the hosting root, if you need to customize further.
158156
See [Angular’s prerendering guide](https://angular.io/guide/prerendering) for more information on those options.
159157

160-
### Optional: add a Server Module
158+
### Optional: add a server module
161159

162160
### Deploy
163161

@@ -228,14 +226,14 @@ export const FIREBASE_ADMIN = new InjectionToken<app.App>('firebase-admin');
228226

229227
```
230228

231-
### Serve fully dynamic content with SSR—Server Side Rendering
229+
## Serve fully dynamic content with SSR—Server Side Rendering
232230

233-
#### Optional: integrate with Firebase Authentication
231+
### Optional: integrate with Firebase Authentication
234232

235233
The web framework-aware Firebase deployment tooling automatically keeps client and server state in sync using cookies. The Express `res.locals` object will optionally contain an authenticated Firebase App instance (`firebaseApp`) and the currently signed in user (`currentUser`). This can be injected into your module via the REQUEST token (exported from @nguniversal/express-engine/tokens).
236234

237235

238-
## Guide: "Integrate Next.js"
236+
## Integrate Next.js
239237

240238
Using the Firebase CLI, you can deploy your next.js Web apps to Firebase and serve them with Firebase Hosting. The CLI respects your next.js settings and translates them to Firebase settings with zero or minimal extra configuration on your part. If your app includes dynamic server-side logic, the CLI deploys that logic to Cloud Functions for Firebase.
241239

@@ -315,7 +313,7 @@ The web framework-aware Firebase deployment tooling will automatically keep clie
315313
const firebaseApp = getApp(useRouter().query.__firebaseAppName);
316314
```
317315

318-
## Guide: “Integrate other frameworks with Express.js
316+
## Integrate other frameworks with Express.js
319317

320318
With some additional configuration, you can build on the basic CLI functionality to extend integration support to Frameworks other than Angular and next.js.
321319

0 commit comments

Comments
 (0)