Skip to content

Commit 3af593d

Browse files
jamesdanielsjamesdaniels
authored
Documentation for fir-oss (#326)
Add documentation scaffold and placeholders for https://firebaseopensource.com/
1 parent 121558a commit 3af593d

File tree

10 files changed

+129
-0
lines changed

10 files changed

+129
-0
lines changed

‎docs/angular/.opensource/project.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "Angular adapter",
3+
"platforms": [
4+
"app_hosting"
5+
],
6+
"description": "Official Angular adapter for Firebase App Hosting",
7+
"content": "README.md"
8+
}

‎docs/angular/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# App Hosting Angular Adapter
2+
3+
Official Angular support for Firebase App Hosting.
4+
5+
### Versions supported
6+
7+
| Version | Status | Deprecation |
8+
|---------|--------|-----------------------|
9+
| 18.2.x | lts | 2026-10-9 |
10+
| 19.0.x | active | not before 2025-10-9 |
11+
| 19.1.x | active | not before 2025-10-9 |
12+
| 19.2.x | active | - |
13+
14+
[See Firebase App Hosting's runtime support policy](https://firebase.google.com/docs/app-hosting/frameworks-tooling#runtimes-for-app-hosting) for more information.
15+
16+
## Known limitations
17+
18+
* **I18n:** While core I18n functionality works, direct navigation to SSR pages can result in errors.
19+
* **Localization:** Building versions for different locales isn't supported.
20+
* **Builders:** Only the Application builder is currently supported.
21+
* **Environments and Monorepo Tooling:** Angular projects that have more than a single application target will fail. For more complete monorepo support, use Nx.
22+
23+
[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.

‎docs/astro/.opensource/project.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "Astro adapter",
3+
"platforms": [
4+
"app_hosting"
5+
],
6+
"description": "Experimental Astro adapter for Firebase App Hosting",
7+
"content": "README.md"
8+
}

‎docs/astro/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# App Hosting Astro Adapter
2+
3+
Experimental support for Astro on Firebase App Hosting, [see the work-in-progress here](https://github.com/FirebaseExtended/firebase-framework-tools/pull/297).
4+
5+
## Instructions for use
6+
7+
To use follow these instructions:
8+
9+
1. Install the `@apphosting/astro-adapter` Astro adapter with the following command in your terminal:
10+
`npx astro add @apphosting/astro-adapter`
11+
1. Add the adapter with the standalone rendering mode to your astro.config.* file:
12+
```js
13+
import { defineConfig } from 'astro/config';
14+
import node from '@apphosting/astro-adapter';
15+
16+
export default defineConfig({
17+
output: 'server',
18+
adapter: node({
19+
mode: 'standalone',
20+
}),
21+
});
22+
```
23+
1. Push the changes to github and kickoff a new rollout
24+
25+
> **Experimental:** While this adapter was built by Google employees, it is not currently an official Google Cloud product. Support is best-effort only.

‎docs/nextjs/.opensource/project.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "Next.js adapter",
3+
"platforms": [
4+
"app_hosting"
5+
],
6+
"description": "Official Next.js adapter for Firebase App Hosting",
7+
"content": "README.md"
8+
}

‎docs/nextjs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# App Hosting Next.js Adapter
2+
3+
Official Next.js support for Firebase App Hosting.
4+
5+
## Versions supported
6+
7+
| Version | Status | Deprecation |
8+
|---------|--------|-----------------------|
9+
| 13.5.x | lts | 2026-10-9 |
10+
| 14.2.x | lts | 2026-10-9 |
11+
| 15.0.x | active | not before 2025-10-9 |
12+
| 15.1.x | active | not before 2025-10-9 |
13+
| 15.2.x | active | - |
14+
15+
[See Firebase App Hosting's runtime support policy](https://firebase.google.com/docs/app-hosting/frameworks-tooling#runtimes-for-app-hosting) for more information.
16+
17+
## Known limitations
18+
19+
* 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).
20+
* 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.
21+
* 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.
22+
* 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)
23+
24+
[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.

‎docs/nitro/.opensource/project.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "Nitro preset",
3+
"platforms": [
4+
"app_hosting"
5+
],
6+
"related": [
7+
"FirebaseExtended/firebase-framework-tools::docs::nuxt"
8+
],
9+
"description": "Community-supported Nitro preset for Firebase App Hosting",
10+
"content": "README.md"
11+
}

‎docs/nitro/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# App Hosting Nitro Adapter
2+
3+
4+
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).
5+
6+
> **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.

‎docs/nuxt/.opensource/project.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "Nuxt adapter",
3+
"platforms": [
4+
"app_hosting"
5+
],
6+
"related": [
7+
"FirebaseExtended/firebase-framework-tools::docs::nitro"
8+
],
9+
"description": "Deploy Nuxt applications to Firebase App Hosting using the community-supported Nitro adapter",
10+
"content": "README.md"
11+
}

‎docs/nuxt/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Nuxt on Firebase App Hosting
2+
3+
Nuxt support on Firebase App Hosting is powered by the [community-supported Nitro preset](https://firebaseopensource.com/projects/FirebaseExtended/firebase-framework-tools::docs::nuxt).
4+
5+
> **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.

0 commit comments

Comments
 (0)