Skip to content

docs(): authentication tutorial with ionic and rxjs compact for angularfire2 ^rc.10 #1721

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

Merged
merged 7 commits into from
Aug 2, 2018

Conversation

hiepxanh
Copy link
Contributor

@hiepxanh hiepxanh commented Jun 11, 2018

authentication with ionic and firebase

Checklist

  • Issue number for this PR: #1601 #1600 #1719 #1733
  • Docs included?: yes
  • Test units included?: no
  • In a clean directory, yarn install, yarn test run successfully? yes

Description

Updating our documentation on Ionic Authentication. it work with google and facebook

authentication with ionic and firebase
Copy link
Collaborator

@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.

@hiepxanh Thank you so much for sending in this PR!

I have a few comments around formatting, capitalization, and small typos. Nothing major.

Don't worry about the number of comments. We don't have a formatting guide for these kind of docs so this was bound to happen.

Don't hesitate to ask me if you need clarity from a comment of mine.

@@ -0,0 +1,94 @@
# STEP 1: install this plugin:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Use capitalization instead of uppercase for the word "step". I find that when something is placed in uppercase by itself too many times it can come off a bit aggressive.

@@ -0,0 +1,94 @@
# STEP 1: install this plugin:
```
1) ionic cordova plugin add cordova-universal-links-plugin
Copy link
Collaborator

Choose a reason for hiding this comment

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

Drop the numbers so it's copy and paste-able.


# STEP 2: Add Firebase to your Ionic

STEP 2.1: [setup firebase to angular project]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Instead of sub numbering the steps just place the action in bold.

Setup Firebase to the Angular Project


# STEP 2: Add Firebase to your Ionic

STEP 2.1: [setup firebase to angular project]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Link formatting is broken here

STEP 2.1: [setup firebase to angular project]
(https://github.com/angular/angularfire2/blob/master/docs/install-and-setup.md)

STEP 2.2: To set up an Android app, go to [Firebase Console](https://console.firebase.google.com/) then
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nitpick: Small typo "To set up in an Android app, go to..."

return this.oauthSignIn(new firebase.auth.GoogleAuthProvider());
}

private oauthSignIn(provider: AuthProvider) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

The code formatting is off in this sample. Try pasting it into an editor to clean it up for you and then paste it back in here.

}
```

# Problem 1:
Copy link
Collaborator

Choose a reason for hiding this comment

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

I really like that you have a common problems section. Try using that title as the header:

Common problems


# Problem 1:

if you got error when build code like this:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Try: "If you received an error like this during a build"

# Problem 1:

if you got error when build code like this:
`UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot read property 'manifest' of undefined`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Use a three backtick code block here:

UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot read property 'manifest' of undefined

if you got error when build code like this:
`UnhandledPromiseRejectionWarning: Unhandled promise rejection (rejection id: 1): TypeError: Cannot read property 'manifest' of undefined`

Please, using this fix from [issue](https://github.com/nordnet/cordova-universal-links-plugin/issues/134):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Try: "Use this fix from..."

@hiepxanh
Copy link
Contributor Author

hiepxanh commented Jun 21, 2018

Yes sir! thank you for showing my fault. I'm on my way

@davideast
Copy link
Collaborator

davideast commented Jun 21, 2018

No faults! We don't have clear guides on formats so there's going to be a bit of back and forth to get it into shape. You're doing great and we're really lucky to have docs contributed like this!

@hiepxanh hiepxanh changed the title authentication tutorial with ionic doc(): Authentication tutorial with ionic Jun 21, 2018
@hiepxanh hiepxanh changed the title doc(): Authentication tutorial with ionic docs(): authentication tutorial with ionic Jun 21, 2018
STEP 3.1: In the Firebase console, open the **Dynamic Links** section at bottom left panel, setup by they instruction

STEP 3.2: add this to config.xml at root level of project:
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Add syntax highlighting perhaps?

```xml

```


# STEP 4: add login code:
at login.service.ts add this function:
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Syntax highlighting here as well

```ts

```

hiepxanh added 2 commits June 25, 2018 08:33
thank you @davideast for guiding me to present the article better
@hiepxanh
Copy link
Contributor Author

hiepxanh commented Jun 25, 2018

thank you @Chan4077 @davideast for guiding me to present the article better. �@davideast I was so pleased to receive your encouragement. Would you mind to help me to check my new update ?

@hiepxanh hiepxanh changed the title docs(): authentication tutorial with ionic docs(): authentication tutorial with ionic and rxjs compact for angularfire2 ^rc.10 Jun 29, 2018
@hiepxanh
Copy link
Contributor Author

@davideast I already updated sir, can you check on my commit?

@davideast davideast merged commit f2bfda9 into angular:master Aug 2, 2018
@davideast
Copy link
Collaborator

Thanks @hiepxanh!

@hiepxanh
Copy link
Contributor Author

hiepxanh commented Aug 2, 2018

you're welcome. I'm happy to help

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.

4 participants