angular / angular/angularfire

Update docs around Universal

未关闭
#2,730 7 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
7.8k
派生
2.2k
平均合并
22 小时 28 分钟
30 天内合并 PR
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 设置能否在 repository 当前的结构下运行。

由索引模型根据 Issue 内容生成。

评估

技术栈
angular, typescript
领域
documentation, web-dev
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。