Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(universal): getting started, serving with Cloud Functions, and prerendering #1841

Merged
merged 15 commits into from Sep 11, 2018

Conversation

jamesdaniels
Copy link
Member

@jamesdaniels jamesdaniels commented Aug 27, 2018

Checklist

  • Issue number for this PR: #nnn (required)
  • Docs included?: (yes/no; required for all API/functional changes)
  • Test units included?: (yes/no; required)
  • In a clean directory, yarn install, yarn test run successfully? (yes/no; required)

Description

Extracted code from jamesdaniels/AngularFireDocs.

Code sample

@jamesdaniels
Copy link
Member Author

FYI @codediodeio this is where I think I'm going with the Universal Docs, thoughts?

README.md Outdated
@@ -76,7 +76,7 @@ Firebase offers two cloud-based, client-accessible database solutions that suppo

#### Realtime Database

> `AngularFireDatabase` allows you to work with the Realtime Database, Firebase's original database. It's an efficient, low-latency solution for mobile apps that require synced states across clients in realtime.
> `AngularFireDatabase` allows you to work with the Realtime Database, Firebase's original database. It's an efficient, low-latency solution for mobile apps that require synced states across clients in real-time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"realtime" over "real-time" this goes way back to the early Firebase days.

@jamesdaniels jamesdaniels changed the title WIP Angular Universal docs docs(universal): getting started, serving with Cloud Functions, and prerendering Sep 7, 2018
@jamesdaniels
Copy link
Member Author

@davideast addressed and flushed out more.

Copy link
Member

@davideast davideast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have two small comments but feel free to address them later. LGTM

@@ -1,11 +1,11 @@
# Server-side Rendering with Universal
# Getting started with Angularfire and Universal
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mega nit: AngularFire



```js
const path = require('path');
const webpack = require('webpack');

const APP_NAME = 'YOUR_PROJECT_NAME';
const APP_NAME = 'YOUR_PROJECT_NAME'; // TODO: replace me!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need more context around 'YOUR_APP_NAME. Something comment like "This is the same as the folder name...".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better yet, my mid-term plan here is to read the paths from the angular.json file; need to fiddle there. SGTY?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM!

@jamesdaniels jamesdaniels merged commit b4eca1b into master Sep 11, 2018
@jamesdaniels jamesdaniels deleted the universal_docs branch September 11, 2018 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants