angular / angular/angularfire

Update docs around Universal

Đang mở
#2,730 7 bình luận 3 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
7.8k
Fork
2.2k
Merge trung bình
22 giờ 28 phút
Pull request đã merge (30 ngày)
6

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu với docs/universal/getting-started.md và so sánh tài liệu này với sample/server.ts hiện tại, các package script, thiết lập webpack và universal cloud function. Cập nhật tài liệu để khớp với dự án mẫu, bao gồm các thay đổi trong server.ts và Firestore protos loader, sau đó xác minh rằng thiết lập Firebase Universal được mô tả hoạt động với cấu trúc hiện tại của repository.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
angular, typescript
Lĩnh vực
documentation, web-dev
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.