Skip to content

Commit b0a7569

Browse files
authored
update screenshot and doc
1 parent b3e23f5 commit b0a7569

File tree

1 file changed

+14
-32
lines changed

1 file changed

+14
-32
lines changed

README.md

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,25 @@
11
# flutter_chat
22

3-
A Chat Helper for Flutter using Firebase as backend services.
4-
5-
## Getting Started
6-
Add this to your package's pubspec.yaml file:<br/>
7-
dependencies:<br/>
8-
## flutter_chat: ^0.1.5<br/>
9-
10-
You can install packages from the command line:<br/> with Flutter:<br/> $ flutter pub get<br/>
11-
12-
Use ChatData.dart for start building your chat.
3+
A Chat Helper for create chat application in Flutter using Firebase as backend services.
134

145
## Features:
156
1. 1-1 chat
167
2. User online status
178

18-
You can use your own widget in Stateful Widget Class.
19-
Steps:
20-
1. add firebase in your android and ios project
21-
2. Create a Stateful widget class and call the method in body
22-
within initState():
23-
-> ChatData.init("app name",context);
24-
3. and in body of Widget build:
25-
-> ChatData.widgetWelcomeScreen(context)
26-
27-
You can use common methods for your application:
28-
## Useful Methods:
29-
1. Auth user from Google SignIn, if user is using app first time,
30-
then user data store in firestore in "users" document,
31-
send true if authenticated,else false
32-
authUsersGoogle() → Future
9+
## Screenshots:
3310

34-
2. check if user is loggedin with social
35-
isSignedIn() → Future
11+
![login screen](https://1.bp.blogspot.com/-hM837Uh65W0/Xj7adGUmwxI/AAAAAAAANjo/PoDM9bh7rZQqT37yIOu-IXAX4F-5W0NNgCLcBGAsYHQ/s640/splash_screen.jpg)
12+
![user screen](https://1.bp.blogspot.com/-ok2AZvPw9FY/Xj7adz8i8vI/AAAAAAAANjw/TTXUBkbbBv8Ti4AvzVOVIWo5o_V6Ei63ACLcBGAsYHQ/s640/user_list.jpg)
13+
![chat screen](https://1.bp.blogspot.com/-r2TK8wT_mV8/Xj7ade30n8I/AAAAAAAANjs/Uw6OQCBpf-Ec0Cm5XB9DIykJ5VGpDfpyACLcBGAsYHQ/s640/chat_screen.jpg)
3614

37-
3. Check user authentication, if authenticated then show dashboard screen, else login screen
38-
authUser(BuildContext context) → void
15+
## Getting Started
16+
* Add this to your package's pubspec.yaml file:<br/>
17+
dependencies:<br/>[flutter_chat](https://pub.dev/packages/flutter_chat)
3918

40-
4. used to create splash screen, shows splash for 2 sec and then call to check authentication
41-
startTime(BuildContext context) → Future
19+
* add [firebase](https://firebase.google.com/) in your android and ios project.
4220

43-
Now enjoy the chat.
21+
* Create a Stateful widget class and call the method in body (example can be found in Github repo),<br/>
22+
within initState():<br/>
23+
-> ChatData.init("app name",context); <br/>
24+
and in body of Widget build:<br/>
25+
-> ChatData.widgetWelcomeScreen(context)

0 commit comments

Comments
 (0)