From 8386de5f53c3668f5d8add4e9bbdab8b233ee34b Mon Sep 17 00:00:00 2001 From: Austin Crim Date: Tue, 22 Aug 2023 16:33:13 -0500 Subject: [PATCH 1/3] add svelte.md --- src/frameworks/docs/svelte.md | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 src/frameworks/docs/svelte.md diff --git a/src/frameworks/docs/svelte.md b/src/frameworks/docs/svelte.md new file mode 100644 index 00000000000..107f3b22d1b --- /dev/null +++ b/src/frameworks/docs/svelte.md @@ -0,0 +1,50 @@ +# Integrate Svelte + +Using the Firebase CLI, you can deploy your Svelte static web apps to Firebase +and serve them with Firebase Hosting. + +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](/docs/cli#install_the_firebase_cli) using your preferred + method. +- Optional: An existing Svelte project using Vite. You can create one with + `npm create vite@latest -- --template svelte` or let the Firebase CLI + [initialize a new project](#initialize-a-new-project) for you. + + +## 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: + 
firebase experiments:enable webframeworks
+1. Run the initialization command from the CLI and then follow the prompts: + 
firebase init hosting
+1. Answer yes to "Do you want to use a web framework? (experimental)" +1. Choose your hosting source directory. If there is an existing Svelte + codebase (with Vite), the CLI detects it and the process completes. + +## Serve static content + +After initializing Firebase, you can serve static content with the standard +deployment command: + +```shell +firebase deploy +``` + +You can [view your deployed app](/docs/hosting/test-preview-deploy#view-changes) +on its live site. From 307706e28160a59dbd16ab9b3199cfdc40d620e3 Mon Sep 17 00:00:00 2001 From: Austin Crim Date: Fri, 25 Aug 2023 15:02:28 -0500 Subject: [PATCH 2/3] consolidate to vite.md --- src/frameworks/docs/lit.md | 3 +++ src/frameworks/docs/preact.md | 3 +++ src/frameworks/docs/react.md | 49 +-------------------------------- src/frameworks/docs/svelte.md | 49 +-------------------------------- src/frameworks/docs/vite.md | 51 +++++++++++++++++++++++++++++++++++ 5 files changed, 59 insertions(+), 96 deletions(-) create mode 100644 src/frameworks/docs/lit.md create mode 100644 src/frameworks/docs/preact.md create mode 100644 src/frameworks/docs/vite.md diff --git a/src/frameworks/docs/lit.md b/src/frameworks/docs/lit.md new file mode 100644 index 00000000000..f020bede473 --- /dev/null +++ b/src/frameworks/docs/lit.md @@ -0,0 +1,3 @@ +# Integrate Lit + +Lit support is built on the Vite framework integration. See [vite.md](./vite.md) for full guidance. \ No newline at end of file diff --git a/src/frameworks/docs/preact.md b/src/frameworks/docs/preact.md new file mode 100644 index 00000000000..6be4f313eb0 --- /dev/null +++ b/src/frameworks/docs/preact.md @@ -0,0 +1,3 @@ +# Integrate Preact + +Preact support is built on the Vite framework integration. See [vite.md](./vite.md) for full guidance. \ No newline at end of file diff --git a/src/frameworks/docs/react.md b/src/frameworks/docs/react.md index 7c0242c2a71..4cc7807432f 100644 --- a/src/frameworks/docs/react.md +++ b/src/frameworks/docs/react.md @@ -1,50 +1,3 @@ # Integrate React -Using the Firebase CLI, you can deploy your React static web apps to Firebase -and serve them with Firebase Hosting. - -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](/docs/cli#install_the_firebase_cli) using your preferred - method. -- Optional: An existing React project using Vite. You can create one with - `npm create vite@latest -- --template react` or let the Firebase CLI - [initialize a new project](#initialize-a-new-project) for you. - - -## 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: - 
firebase experiments:enable webframeworks
-1. Run the initialization command from the CLI and then follow the prompts: - 
firebase init hosting
-1. Answer yes to "Do you want to use a web framework? (experimental)" -1. Choose your hosting source directory. If there is an existing React - codebase (with Vite), the CLI detects it and the process completes. - -## Serve static content - -After initializing Firebase, you can serve static content with the standard -deployment command: - -```shell -firebase deploy -``` - -You can [view your deployed app](/docs/hosting/test-preview-deploy#view-changes) -on its live site. +React support is built on the Vite framework integration. See [vite.md](./vite.md) for full guidance. \ No newline at end of file diff --git a/src/frameworks/docs/svelte.md b/src/frameworks/docs/svelte.md index 107f3b22d1b..9f1b75003b1 100644 --- a/src/frameworks/docs/svelte.md +++ b/src/frameworks/docs/svelte.md @@ -1,50 +1,3 @@ # Integrate Svelte -Using the Firebase CLI, you can deploy your Svelte static web apps to Firebase -and serve them with Firebase Hosting. - -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](/docs/cli#install_the_firebase_cli) using your preferred - method. -- Optional: An existing Svelte project using Vite. You can create one with - `npm create vite@latest -- --template svelte` or let the Firebase CLI - [initialize a new project](#initialize-a-new-project) for you. - - -## 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: - 
firebase experiments:enable webframeworks
-1. Run the initialization command from the CLI and then follow the prompts: - 
firebase init hosting
-1. Answer yes to "Do you want to use a web framework? (experimental)" -1. Choose your hosting source directory. If there is an existing Svelte - codebase (with Vite), the CLI detects it and the process completes. - -## Serve static content - -After initializing Firebase, you can serve static content with the standard -deployment command: - -```shell -firebase deploy -``` - -You can [view your deployed app](/docs/hosting/test-preview-deploy#view-changes) -on its live site. +Svelte support is built on the Vite framework integration. See [vite.md](./vite.md) for full guidance. \ No newline at end of file diff --git a/src/frameworks/docs/vite.md b/src/frameworks/docs/vite.md new file mode 100644 index 00000000000..757ed81ade1 --- /dev/null +++ b/src/frameworks/docs/vite.md @@ -0,0 +1,51 @@ +# Integrate Vite + +Using the Firebase CLI, you can deploy your Vite-powered sites to Firebase +and serve them with Firebase Hosting. The following instructions also apply +to React, Preact, Lit, and Svelte as they are built on the Vite integration. + +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](/docs/cli#install_the_firebase_cli) using your preferred + method. +- Optional: An existing Vite project. You can create one with + `npm create vite@latest` or let the Firebase CLI + [initialize a new project](#initialize-a-new-project) for you. + + +## 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: + 
firebase experiments:enable webframeworks
+1. Run the initialization command from the CLI and then follow the prompts: + 
firebase init hosting
+1. Answer yes to "Do you want to use a web framework? (experimental)" +1. Choose your hosting source directory. If there is an existing Vite codebase, + the CLI detects it and the process completes. + +## Serve static content + +After initializing Firebase, you can serve static content with the standard +deployment command: + +```shell +firebase deploy +``` + +You can [view your deployed app](/docs/hosting/test-preview-deploy#view-changes) +on its live site. From 17c44274eb98578b94476d7f4949ff1212929377 Mon Sep 17 00:00:00 2001 From: Austin Crim Date: Mon, 28 Aug 2023 08:53:51 -0500 Subject: [PATCH 3/3] pr comments --- src/frameworks/docs/vite.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/frameworks/docs/vite.md b/src/frameworks/docs/vite.md index 757ed81ade1..181bf85efcd 100644 --- a/src/frameworks/docs/vite.md +++ b/src/frameworks/docs/vite.md @@ -15,11 +15,11 @@ 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](/docs/cli#install_the_firebase_cli) using your preferred + [install the CLI](https://firebase.google.com/docs/cli#install_the_firebase_cli) using your preferred method. - Optional: An existing Vite project. You can create one with `npm create vite@latest` or let the Firebase CLI - [initialize a new project](#initialize-a-new-project) for you. + initialize a new project for you. ## Initialize Firebase @@ -47,5 +47,5 @@ deployment command: firebase deploy ``` -You can [view your deployed app](/docs/hosting/test-preview-deploy#view-changes) +You can [view your deployed app](https://firebase.google.com/docs/hosting/test-preview-deploy#view-changes) on its live site.