-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add nuxt.md to docs
#6303
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
leoortizz
merged 13 commits into
firebase:master
from
monogramdesign:leoortizz_nuxt-docs
Dec 7, 2023
Merged
Add nuxt.md to docs
#6303
Changes from 5 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
7ca0295
Nuxt docs WIP
leoortizz 9bd56b6
finish nuxt docs
JulienMartel de22313
fix broken link
JulienMartel e2bcec1
fix broken link in svelte too
JulienMartel f3024d5
pr review changes: broken link
JulienMartel 30904f9
remove init section
JulienMartel ce7b612
fix init section
JulienMartel e5d7e96
Merge branch 'master' into leoortizz_nuxt-docs
leoortizz a89ff27
Vscode emulators (#6256)
christhompsongoogle fc42b1f
add Vite and related frameworks readme (#6289)
2a91eb9
Merge branch 'master' into leoortizz_nuxt-docs
JulienMartel 17a0029
Merge branch 'master' into leoortizz_nuxt-docs
jamesdaniels 868ef46
Merge branch 'master' into leoortizz_nuxt-docs
jamesdaniels File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Integrate Nuxt | ||
|
|
||
| Using the Firebase CLI, you can deploy your Nuxt apps to Firebase and | ||
| serve them with Firebase Hosting. The CLI respects your Nuxt 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. | ||
|
|
||
| Note: Framework-aware Hosting is an early public preview. This means | ||
| that the functionality might change in backward-incompatible ways. A preview | ||
| release is not subject to any SLA or deprecation policy and may receive limited | ||
| or no support. | ||
|
|
||
| ## Before you begin | ||
|
|
||
| Before you get started deploying your app to Firebase, | ||
| review the following requirements and options: | ||
|
|
||
| - Firebase CLI version 12.1.0 or later. Make sure to | ||
| [install the CLI](https://firebase.google.com/docs/cli#install_the_firebase_cli) | ||
| using your preferred method. | ||
| - Optional: Billing enabled on your Firebase project | ||
| (required if you plan to use SSR) | ||
| - An existing Nuxt (version 3+) project. You can create one with `npx nuxi@latest init <project-name>`. | ||
|
|
||
|
|
||
| ## Initialize Firebase | ||
|
|
||
| To get started, initialize Firebase for your framework project. | ||
| Use the Firebase CLI for a new project, or modify `firebase.json` for an | ||
| existing project. | ||
|
|
||
| ### Initialize a new project | ||
|
|
||
| 1. In the Firebase CLI, enable the web frameworks preview: | ||
| <pre class="devsite-terminal">firebase experiments:enable webframeworks</pre> | ||
| 2. Run the initialization command from the CLI and then follow the prompts: | ||
| <pre class="devsite-terminal">firebase init hosting</pre> | ||
| 3. Answer yes to "Do you want to use a web framework? (experimental)" | ||
| 4. Choose your hosting source directory. | ||
| If there is an existing Nuxt codebase, | ||
| the CLI detects it and the process completes. | ||
|
|
||
| ## Deployment | ||
|
|
||
| After initializing Firebase, you can deploy your Nuxt app with the standard | ||
| deployment command: | ||
|
|
||
| ```shell | ||
| firebase deploy | ||
| ``` | ||
|
|
||
| ## Serve static content | ||
|
|
||
| If your Nuxt app uses [`ssr: false`](https://nuxt.com/docs/api/configuration/nuxt-config#ssr), | ||
| the Firebase CLI will correctly detect and configure your build to serve fully | ||
| static content on Firebase Hosting. | ||
|
|
||
| ## Server-side rendering | ||
|
|
||
| The Firebase CLI will detect usage of [`ssr: true`](https://nuxt.com/docs/api/configuration/nuxt-config#ssr). | ||
| In such cases, the Firebase CLI will deploy functions to Cloud Functions for Firebase to run dynamic | ||
| server code. You can view information about these functions, such as their domain and runtime | ||
| configuration, in the [Firebase console](https://console.firebase.google.com/project/_/functions). | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.