[firebase_auth] update example app and README #1219

cyanglaz · 2019-02-14T18:34:09Z

This is an improvement of the documentation and the example for flutter/flutter#16217

Added a registration flow and a sign in with email&password flow in the example app.
Separated the example app into 2 parts: registration and SignIn/SignOut.
Updated README, added a list of supported authentication methods and an example of registration.

collinjackson

Thanks for doing this. Most of my suggestions are English style nits.

collinjackson · 2019-02-19T16:15:42Z

packages/firebase_auth/README.md

+
+### Supported firebase authentication methods.
+
+Supported authentication methods includes `Google authentication`, `Email&Password authentication`, `Phone authentication` and `Anonymously Sign in`.


I think we should include the full list if we're going to include a list them at all.

This sentence has some capitalization, spacing, grammar, and consistency issues. Maybe just have a bulleted list instead of a sentence.

Do you mean the' full list' that supported by Firebase or supported by us? The list I added here is all the supported I found in dart implementation, maybe I missed something?
Will fix the english style issues.

We also support Twitter, Facebook, and GitHub. See the full list of auth providers here:

https://github.com/flutter/plugins/tree/master/packages/firebase_auth/lib/src/auth_provider

collinjackson · 2019-02-19T16:16:22Z

packages/firebase_auth/README.md

 ### Phone Auth

 You can use Firebase Authentication to sign in a user by sending an SMS message to
 the user's phone. The user signs in using a one-time code contained in the SMS message.

+### After authentication
+
+After a successful authentication, you should get a FirebaseUser object. You can use this object to check if the email is verified, to update email, to send verification email and etc. See [Documentation](https://pub.dartlang.org/documentation/firebase_auth/latest/firebase_auth/FirebaseUser-class.html) for more details on the FirebaseUser Object.


you will receive.

put backticks around FirebaseUser in both places

collinjackson · 2019-02-19T16:17:38Z

packages/firebase_auth/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.8.1+1
+
+* Updates README.


I would describe what changed in the example app

collinjackson · 2019-02-19T16:18:24Z

packages/firebase_auth/README.md

@@ -83,11 +83,30 @@ _handleSignIn()
    .catchError((e) => print(e));
 ```

+### Register a user
+
+You can now register a new user using firebase_auth, e.g.


I would just remove this line, it seems redundant

collinjackson · 2019-02-19T16:18:44Z

packages/firebase_auth/README.md

+    );
+```
+
+### Supported firebase authentication methods.


Firebase is always capitalized. No need for a period.

collinjackson · 2019-02-19T16:25:11Z

packages/firebase_auth/example/lib/signin_page.dart

+            onPressed: () async {
+              _verifyPhoneNumber();
+            },
+            child: const Text('Veity phone number'),


collinjackson · 2019-02-19T16:25:29Z

packages/firebase_auth/example/lib/signin_page.dart

+            onPressed: () async {
+              _signInWithPhoneNumber();
+            },
+            child: const Text('Sign in with Phone number'),


no need to capitalize Phone

collinjackson · 2019-02-19T16:25:40Z

packages/firebase_auth/example/lib/signin_page.dart

+        ),
+        TextField(
+          controller: _smsController,
+          decoration: InputDecoration(labelText: 'verification code'),


I would probably capitalize Verification

collinjackson · 2019-02-19T16:26:25Z

packages/firebase_auth/example/lib/signin_page.dart

+  }
+}
+
+class _AnonymouslySigninSection extends StatefulWidget {


capitalize In

collinjackson · 2019-02-19T16:26:42Z

packages/firebase_auth/example/lib/signin_page.dart

+  }
+}
+
+class _GoogleSigninSection extends StatefulWidget {


capitalize In

collinjackson · 2019-02-21T15:08:10Z

packages/firebase_auth/CHANGELOG.md

+## 0.8.1+2
+
+* Update README.
+* Update the example app. The example app now have two separate pages includes a `Registration` page and a `SignIn/SignOut` page. The SignIn methods included in the `SignIn/SignOut` page are:


There are some English language issues with this changelog entry. It might be sufficient to just say "Updated the example app with separate pages for registration and sign-in."

collinjackson · 2019-02-21T15:08:34Z

packages/firebase_auth/README.md

@@ -10,7 +10,7 @@ For Flutter plugins for other Firebase products, see [FlutterFire.md](https://gi
 ## Usage

 ### Configure the Google sign-in plugin
-The Google Sign-in plugin is required to use the firebase_auth plugin. Follow the [Google sign-in plugin installation instructions](https://pub.dartlang.org/packages/google_sign_in#pub-pkg-tab-installing).
+The Google Sign-in plugin is required to use the Firebase_auth plugin. Follow the [Google sign-in plugin installation instructions](https://pub.dartlang.org/packages/google_sign_in#pub-pkg-tab-installing).


Don't capitalize firebase_auth here

collinjackson · 2019-02-21T15:09:48Z

packages/firebase_auth/README.md

+### Supported Firebase authentication methods
+
+* `Google authentication`
+* `Email&Password authentication`


I would say Email and password

collinjackson · 2019-02-21T15:10:15Z

packages/firebase_auth/README.md

+    );
+```
+
+### Supported Firebase authentication methods


For this list I think you don't need backticks, and I'd remove "authentication" since it applies to everything on the list

collinjackson · 2019-02-21T15:10:26Z

packages/firebase_auth/README.md

+* `Email&Password authentication`
+* `Phone authentication`
+* `Anonymously Sign in`
+* `Github authentication`


Capitalize H

collinjackson · 2019-02-21T15:14:16Z

packages/firebase_auth/README.md

 ### Phone Auth

 You can use Firebase Authentication to sign in a user by sending an SMS message to
 the user's phone. The user signs in using a one-time code contained in the SMS message.

+### After authentication
+
+After a successful authentication, you will receive a `FirebaseUser` object. You can use this object to check if the email is verified, to update email, to send verification email and etc. See [Documentation](https://pub.dartlang.org/documentation/firebase_auth/latest/firebase_auth/FirebaseUser-class.html) for more details on the `FirebaseUser` Object.


Change etc to "and so on"

I would say something like this:

See the FirebaseUser API documentation for more details.

packages/firebase_auth/example/lib/main.dart

cyanglaz · 2019-02-21T17:36:53Z

Fixed all review issues.

collinjackson · 2019-02-25T20:03:10Z

packages/firebase_auth/README.md

 ### Phone Auth

 You can use Firebase Authentication to sign in a user by sending an SMS message to
 the user's phone. The user signs in using a one-time code contained in the SMS message.

+### After authentication
+
+After a successful authentication, you will receive a `FirebaseUser` object. You can use this object to check if the email is verified, to update email, to send verification email and so on. See the [FirebaseUser](https://pub.dartlang.org/documentation/firebase_auth/latest/firebase_auth/FirebaseUser-class.html) API documentation for more details on the `FirebaseUser` Object.


no need to capitalize Object

This is an improvement of the documentation and the example for [flutter/flutter#16217](flutter/flutter#16217) Added a registration flow and a sign in with email&password flow in the example app. Separated the example app into 2 parts: registration and SignIn/SignOut. Updated README, added a list of supported authentication methods and an example of registration.

update example app and README

1dbc587

cyanglaz requested review from collinjackson and kroikie as code owners February 14, 2019 18:34

googlebot added the cla: yes label Feb 14, 2019

Chris Yang added 2 commits February 14, 2019 11:17

nit fixes

6006f59

formating

a1e2696

collinjackson reviewed Feb 19, 2019

View reviewed changes

Chris Yang added 5 commits February 19, 2019 09:30

merge master

669f6bf

review fixes

6d806aa

update README to include all supported authentication methods

5d8a264

english fix

d1cece1

add other provider authentications

9825ec8

collinjackson reviewed Feb 21, 2019

View reviewed changes

Chris Yang added 2 commits February 21, 2019 09:21

review fixes

28d950e

merge master and reslove conflicts

b6d13e3

cyanglaz changed the title ~~update example app and README~~ [firebase_auth]update example app and README Feb 21, 2019

bparrishMines changed the title ~~[firebase_auth]update example app and README~~ [firebase_auth] update example app and README Feb 22, 2019

bparrishMines added feature documentation flutterfire labels Feb 22, 2019

resolve conflicts

142dbcc

collinjackson approved these changes Feb 25, 2019

View reviewed changes

Chris Yang added 2 commits February 25, 2019 13:15

nit

0ef6819

merge master

3e138a8

cyanglaz merged commit bb75009 into flutter:master Feb 26, 2019

cyanglaz mentioned this pull request Feb 26, 2019

firebase_auth: Clearer docs flutter/flutter#16217

Closed

cyanglaz deleted the firebase_auth_example_doc branch February 27, 2019 17:55

collinjackson mentioned this pull request Jun 15, 2019

[firebase_auth]Updated the sign in methods to use new methods #1064

Closed


		### Supported firebase authentication methods.

		Supported authentication methods includes `Google authentication`, `Email&Password authentication`, `Phone authentication` and `Anonymously Sign in`.

[firebase_auth] update example app and README #1219

[firebase_auth] update example app and README #1219

Uh oh!

Conversation

cyanglaz commented Feb 14, 2019

Uh oh!

collinjackson left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cyanglaz commented Feb 21, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

collinjackson left a comment •

edited

Loading