diff --git a/docs/angular/.opensource/project.json b/docs/angular/.opensource/project.json new file mode 100644 index 00000000..c2f25389 --- /dev/null +++ b/docs/angular/.opensource/project.json @@ -0,0 +1,8 @@ +{ + "name": "Angular adapter", + "platforms": [ + "app_hosting" + ], + "description": "Official Angular adapter for Firebase App Hosting", + "content": "README.md" +} \ No newline at end of file diff --git a/docs/angular/README.md b/docs/angular/README.md new file mode 100644 index 00000000..1acc063e --- /dev/null +++ b/docs/angular/README.md @@ -0,0 +1,23 @@ +# App Hosting Angular Adapter + +Official Angular support for Firebase App Hosting. + +### Versions supported + +| Version | Status | Deprecation | +|---------|--------|-----------------------| +| 18.2.x | lts | 2026-10-9 | +| 19.0.x | active | not before 2025-10-9 | +| 19.1.x | active | not before 2025-10-9 | +| 19.2.x | active | - | + +[See Firebase App Hosting's runtime support policy](https://firebase.google.com/docs/app-hosting/frameworks-tooling#runtimes-for-app-hosting) for more information. + +## Known limitations + +* **I18n:** While core I18n functionality works, direct navigation to SSR pages can result in errors. +* **Localization:** Building versions for different locales isn't supported. +* **Builders:** Only the Application builder is currently supported. +* **Environments and Monorepo Tooling:** Angular projects that have more than a single application target will fail. For more complete monorepo support, use Nx. + +[See Firebase App Hosting's FAQ and troubleshooting documentation](https://firebase.google.com/docs/app-hosting/troubleshooting) for up-to-date information on the current limitations of the platform. \ No newline at end of file diff --git a/docs/astro/.opensource/project.json b/docs/astro/.opensource/project.json new file mode 100644 index 00000000..a7216ace --- /dev/null +++ b/docs/astro/.opensource/project.json @@ -0,0 +1,8 @@ +{ + "name": "Astro adapter", + "platforms": [ + "app_hosting" + ], + "description": "Experimental Astro adapter for Firebase App Hosting", + "content": "README.md" +} \ No newline at end of file diff --git a/docs/astro/README.md b/docs/astro/README.md new file mode 100644 index 00000000..0a20e167 --- /dev/null +++ b/docs/astro/README.md @@ -0,0 +1,25 @@ +# App Hosting Astro Adapter + +Experimental support for Astro on Firebase App Hosting, [see the work-in-progress here](https://github.com/FirebaseExtended/firebase-framework-tools/pull/297). + +## Instructions for use + +To use follow these instructions: + +1. Install the `@apphosting/astro-adapter` Astro adapter with the following command in your terminal: +`npx astro add @apphosting/astro-adapter` +1. Add the adapter with the standalone rendering mode to your astro.config.* file: +```js +import { defineConfig } from 'astro/config'; +import node from '@apphosting/astro-adapter'; + +export default defineConfig({ + output: 'server', + adapter: node({ + mode: 'standalone', + }), +}); +``` +1. Push the changes to github and kickoff a new rollout + +> **Experimental:** While this adapter was built by Google employees, it is not currently an official Google Cloud product. Support is best-effort only. diff --git a/docs/nextjs/.opensource/project.json b/docs/nextjs/.opensource/project.json new file mode 100644 index 00000000..9da65f8c --- /dev/null +++ b/docs/nextjs/.opensource/project.json @@ -0,0 +1,8 @@ +{ + "name": "Next.js adapter", + "platforms": [ + "app_hosting" + ], + "description": "Official Next.js adapter for Firebase App Hosting", + "content": "README.md" +} \ No newline at end of file diff --git a/docs/nextjs/README.md b/docs/nextjs/README.md new file mode 100644 index 00000000..557d9018 --- /dev/null +++ b/docs/nextjs/README.md @@ -0,0 +1,24 @@ +# App Hosting Next.js Adapter + +Official Next.js support for Firebase App Hosting. + +## Versions supported + +| Version | Status | Deprecation | +|---------|--------|-----------------------| +| 13.5.x | lts | 2026-10-9 | +| 14.2.x | lts | 2026-10-9 | +| 15.0.x | active | not before 2025-10-9 | +| 15.1.x | active | not before 2025-10-9 | +| 15.2.x | active | - | + +[See Firebase App Hosting's runtime support policy](https://firebase.google.com/docs/app-hosting/frameworks-tooling#runtimes-for-app-hosting) for more information. + +## Known limitations + +* By default, the [built-in NextJS image optimization](https://nextjs.org/.docs/app/building-your-application/optimizing/images) is disabled on App Hosting unless you explicitly set [`images.unoptimized`](https://nextjs.org/docs/pages/api-reference/components/image#unoptimized) to false or use a custom [Image Loader.](https://nextjs.org/docs/app/api-reference/config/next-config-js/images#example-loader-configuration) See [Optimize image loading on Next.js](/docs/app-hosting/optimize-image-loading). +* URL paths containing percent-encoded characters are decoded by Cloud Run. This may cause issues with features that expect only encoded URL paths, such as Next.js parallel routing. +* Currently, App Hosting limits the caching for NextJS apps using [middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware). Over time, cache hit rates should improve. +* URL paths containing percent-encoded characters are decoded by Cloud Run. This may cause issues with features that expect only encoded URL paths, such as [Next.js parallel routing](https://nextjs.org/docs/app/building-your-application/routing/parallel-routes) + +[See Firebase App Hosting's FAQ and troubleshooting documentation](https://firebase.google.com/docs/app-hosting/troubleshooting) for up-to-date information on the current limitations of the platform. \ No newline at end of file diff --git a/docs/nitro/.opensource/project.json b/docs/nitro/.opensource/project.json new file mode 100644 index 00000000..e7c12a58 --- /dev/null +++ b/docs/nitro/.opensource/project.json @@ -0,0 +1,11 @@ +{ + "name": "Nitro preset", + "platforms": [ + "app_hosting" + ], + "related": [ + "FirebaseExtended/firebase-framework-tools::docs::nuxt" + ], + "description": "Community-supported Nitro preset for Firebase App Hosting", + "content": "README.md" +} \ No newline at end of file diff --git a/docs/nitro/README.md b/docs/nitro/README.md new file mode 100644 index 00000000..d4999b9c --- /dev/null +++ b/docs/nitro/README.md @@ -0,0 +1,6 @@ +# App Hosting Nitro Adapter + + +Applications powered by Nitro have zero-configuration support for Firebase App Hosting, using the Firebase App Hosting preset. [Learn more in the Nitro documentation](https://nitro.build/deploy/providers/firebase). + +> **Community-supported:** While built in collaboration with Firebase App Hosting, the Nitro preset is not currently an official Google Cloud product. Support is best-effort only. \ No newline at end of file diff --git a/docs/nuxt/.opensource/project.json b/docs/nuxt/.opensource/project.json new file mode 100644 index 00000000..77733e54 --- /dev/null +++ b/docs/nuxt/.opensource/project.json @@ -0,0 +1,11 @@ +{ + "name": "Nuxt adapter", + "platforms": [ + "app_hosting" + ], + "related": [ + "FirebaseExtended/firebase-framework-tools::docs::nitro" + ], + "description": "Deploy Nuxt applications to Firebase App Hosting using the community-supported Nitro adapter", + "content": "README.md" +} \ No newline at end of file diff --git a/docs/nuxt/README.md b/docs/nuxt/README.md new file mode 100644 index 00000000..aea6f46a --- /dev/null +++ b/docs/nuxt/README.md @@ -0,0 +1,5 @@ +# Nuxt on Firebase App Hosting + +Nuxt support on Firebase App Hosting is powered by the [community-supported Nitro preset](https://firebaseopensource.com/projects/FirebaseExtended/firebase-framework-tools::docs::nuxt). + +> **Community-supported:** While built in collaboration with Firebase App Hosting, the Nitro preset is not currently an official Google Cloud product. Support is best-effort only.