docs(universal): getting started, serving with Cloud Functions, and prerendering #1841
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # Deploying your Universal application on Cloud Functions for Firebase | ||
|
|
||
| Pre-req, previous page, something, something, firebase cli | ||
|
|
||
| ```bash | ||
| npm i -g @firebase-tools | ||
| ``` | ||
|
|
||
| ```bash | ||
| firebase login | ||
| ``` | ||
|
|
||
| Init Firebase if you haven't: | ||
|
|
||
| ```bash | ||
| firebase init | ||
| ``` | ||
|
|
||
| Whatever features you want but at least `functions` and `hosting`. For Functions, choose `typescript` and Hosting the default `public` directory is fine. | ||
|
|
||
| Let's make some modifications to our `package.json`, to build for Functions. | ||
|
|
||
| ```js | ||
| "scripts": { | ||
| // ... omitted | ||
| "build": "ng build && npm run copy:hosting && npm run build:ssr && npm run build:functions", | ||
| "copy:hosting": "cp -r ./dist/YOUR_PROJECT_NAME/* ./public && rm ./public/index.html", | ||
| "build:functions": "npm run --prefix functions build" | ||
| }, | ||
| ``` | ||
|
|
||
| Add the following to your `functions/src/index.ts`: | ||
|
|
||
| ```ts | ||
| export const universal = functions.https.onRequest((request, response) => { | ||
| require(`${process.cwd()}/dist/YOUR_PROJECT_NAME-webpack/server`).app(request, response); | ||
| }); | ||
| ``` | ||
|
|
||
| Change the build script in your `functions/package.json` to the following: | ||
|
|
||
| ```js | ||
| "scripts": { | ||
| // ... omitted | ||
| "build": "rm -r ./dist && cp -r ../dist . && tsc", | ||
| } | ||
| ``` | ||
|
|
||
| Add the following to your `firebase.json`: | ||
|
|
||
| ```js | ||
| { | ||
| // ... | ||
| "hosting": { | ||
| // ... | ||
| "rewrites": [ | ||
| { "source": "**", "function": "universal" } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| We can now run `npm run build`, `firebase serve` and `firebase deploy`. | ||
|
|
||
| Something, something, cache-control... | ||
|
|
||
| ### [Next Step: Prerendering your Universal application](prerendering.md) | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| - [Universal Starter Template](https://github.com/angular/universal-starter) | ||
| - [AngularFirebase SSR Videos](https://angularfirebase.com/tag/ssr/) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # Prerendering your Universal application | ||
|
|
||
| `static.paths.js`: | ||
|
|
||
| ```js | ||
| export default [ | ||
| '/', | ||
| '/another_path', | ||
| '/yet_another_path', | ||
| // ... etc. | ||
| ]; | ||
| ``` | ||
|
|
||
| ```bash | ||
| npm i --save-dev mkdir-recursive | ||
| ``` | ||
|
|
||
| Add the following to your `server.ts`: | ||
|
|
||
| ```ts | ||
| import { readFileSync, writeFileSync, existsSync } from 'fs'; | ||
| import { renderModuleFactory } from '@angular/platform-server'; | ||
| import { mkdirSync } from 'mkdir-recursive'; | ||
|
|
||
| if (process.env.PRERENDER) { | ||
|
|
||
| const routes = require('./static.paths').default; | ||
| Promise.all( | ||
| routes.map(route => | ||
| renderModuleFactory(AppServerModuleNgFactory, { | ||
| document: template, | ||
| url: route, | ||
| extraProviders: [ | ||
| provideModuleMap(LAZY_MODULE_MAP) | ||
| ] | ||
| }).then(html => [route, html]) | ||
| ) | ||
| ).then(results => { | ||
| results.forEach(([route, html]) => { | ||
| const fullPath = join('./public', route); | ||
| if (!existsSync(fullPath)) { mkdirSync(fullPath); } | ||
| writeFileSync(join(fullPath, 'index.html'), html); | ||
| }); | ||
| process.exit(); | ||
| }); | ||
|
|
||
| } else if (!process.env.FUNCTION_NAME) { | ||
|
|
||
| // If we're not in the Cloud Functions environment, spin up a Node server | ||
| const PORT = process.env.PORT || 4000; | ||
| app.listen(PORT, () => { | ||
| console.log(`Node server listening on http://localhost:${PORT}`); | ||
| }); | ||
| } | ||
| ``` | ||
|
|
||
| Let's make some modifications to our `package.json`, to prerender your content: | ||
|
|
||
| ```js | ||
| "scripts": { | ||
| // ... omitted | ||
| "build": "ng build && npm run copy:hosting && npm run build:functions && npm run prerender:ssr", | ||
| "prerender:ssr": "PRERENDER=1 node dist/YOUR_PROJECT_NAME-webpack/server.js", | ||
| }, | ||
| ``` | ||
|
|
||
| Now when you run `npm run build` you should see prerendered content in your `/public` directory, ready for deployment on Firebase Hosting. | ||
|
|
||
| `firebase serve`, `firebase deploy` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"realtime" over "real-time" this goes way back to the early Firebase days.