Update docs around Universal
- 主要言語
- TypeScript
- スター
- 7.8k
- フォーク
- 2.2k
- 平均マージ
- 22時間 28分
- マージ済み PR(30日)
- 6
説明
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
コントリビューションガイド
調査の方向性
docs/universal/getting-started.md から始め、現在の sample/server.ts、パッケージスクリプト、webpack の設定、universal cloud function と比較します。server.ts の変更と Firestore protos loader を含め、サンプルプロジェクトに合うようにドキュメントを更新し、その後、ドキュメントに記載された Firebase Universal のセットアップがリポジトリの現在の構成で動作することを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- angular, typescript
- 領域
- documentation, web-dev
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100