angular / angular/angularfire

Update docs around Universal

Offen
#2,730 7 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
7.8k
Forks
2.2k
Ø Merge
22 Std. 28 Min.
Gemergte PRs (30 T.)
6

Beschreibung

Currently the [docs provided](https://github.com/angular/angularfire/blob/master/docs/universal/getting-started.md) for running universal with firebase have not been updated in over 2 years. Comparing the code provided there with the sample project in this repo, it's easy to spot some differences:

- major changes in [server.ts](https://github.com/angular/angularfire/blob/master/sample/server.ts), notably the lack of AppServerModuleNgFactory and a module mapper, the inclusion of a firestore "protos" loader
- the absence of a webpack config file
- the universal cloud function has changed
- package scripts are different

Given the long running issues and ongoing challenges of doing universal with firebase, it would be awesome to have current docs on how to set this up in a way that is proven to work. If you are open to PRs I could open one.

It may also be worth maintaining a separate repo for a sample project that demonstrates serving routes that use firestore data so we can be sure what works when server-side rendering pages that need firestore data. It would be a great reference but also a great testing ground for when new versions of angular or firebase are released.

Thank you!

### Version info

**Angular: 11**

**Firebase: 8.0.0**

**AngularFire: 6.1.4**

**Other (e.g. Ionic/Cordova, Node, browser, operating system):**

### How to reproduce these conditions

n/a

**Steps to set up and reproduce**

n/a

**Sample data and security rules**

n/a

### Debug output

n/a

### Expected behavior

n/a

### Actual behavior

n/a

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit docs/universal/getting-started.md und vergleiche es mit der aktuellen sample/server.ts, den Package-Skripten, dem webpack-Setup und der universellen Cloud Function. Aktualisiere die Dokumentation so, dass sie dem Beispielprojekt entspricht, einschließlich der Änderungen an server.ts und des Firestore protos loader, und überprüfe anschließend, dass das dokumentierte Firebase Universal-Setup mit der aktuellen Struktur des Repositorys funktioniert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, typescript
Bereich
documentation, web-dev
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.