Update docs around Universal
- Dominant language
- TypeScript
- Stars
- 7.8k
- Forks
- 2.2k
- Avg merge
- 22h 28m
- Merged PRs (30d)
- 6
Description
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
Contributor guide
Research direction
Start with docs/universal/getting-started.md and compare it with the current sample/server.ts, package scripts, webpack setup, and universal cloud function. Update the documentation to match the sample project, including the server.ts changes and Firestore protos loader, then verify that the documented Firebase Universal setup works with the repository's current structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100