Skip to content

Commit 9f8d2ce

Browse files
committed
Add readme
1 parent fd5c715 commit 9f8d2ce

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

readme.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
<p align="center">
2+
<img src="https://i.imgur.com/CbpT7sy.jpg" alt="FirebaseChat" title="FirebaseChat" />
3+
</p>
4+
5+
# React Native Firebase Chat
6+
7+
[![React Native][react_native-badge]][react_native-url]
8+
[![Android Platform][android_platform-badge]][android_platform-url]
9+
[![Android Studio][android_studio-badge]][android_studio-url]
10+
11+
React Native chat application using Firebase backend.
12+
13+
In this project We have used following Firebase serivces.
14+
* **Firebase Authentication** : For authentication user by phone number
15+
* **Firebase RealTime Database** : That's we for handle realtime chat
16+
* **Firebase Storage** : That's we use for store user profile image
17+
18+
BinBytes is an mobile & web application development agency in Rajkot, India. You'll find an overview of all our services [on our website](https://binbytes.com).
19+
20+
## Requirements
21+
22+
### Mandatory
23+
- [Android Studio](https://developer.android.com/studio/index.html).
24+
- [Node](https://nodejs.org), [Watchman](https://facebook.github.io/watchman/) and [React Native](https://facebook.github.io/react-native/).
25+
26+
### Optional
27+
- [VS Code](https://code.visualstudio.com/)
28+
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
29+
30+
## Enviroment Settings
31+
32+
### Mandatory
33+
- Install [Android Studio](https://developer.android.com/studio/index.html) and create an emulator.
34+
- Install [Homebrew](https://brew.sh/).
35+
- Install [Node](https://nodejs.org), [Watchman](https://facebook.github.io/watchman/) and [React Native](https://facebook.github.io/react-native/).
36+
37+
```
38+
brew update
39+
brew install node
40+
brew install watchman
41+
npm install -g react-native-cli
42+
```
43+
44+
### Optional
45+
- Install [VS Code](https://code.visualstudio.com/) and follow extensions: `prettier`
46+
47+
## Firebase Steup
48+
- For Firebase setup you need follow this [instructions](https://firebase.google.com/docs/android/setup)
49+
50+
## Steps to Run
51+
### 1. Clone project and install the dependencies
52+
```
53+
git clone [email protected]:binbytes/react-native-firebase-chat.git && cd react-native-firebase-chat && npm install
54+
```
55+
56+
### 2. Setup firebase in Android
57+
- Download `google-services.json` from Firebase Project and copy it to `react-native-firebase-chat/android/app`
58+
59+
(For download `google-services.json` use [this](https://support.google.com/firebase/answer/7015592))
60+
61+
### 3. Make sure you have started an emulator and run the app on Android
62+
```
63+
react-native run-android
64+
```
65+
66+
## Architecture
67+
68+
<p align="center">
69+
<img src="https://i.imgur.com/RUJUqGE.jpg" />
70+
</p>
71+
72+
## Security
73+
74+
If you discover any security related issues, please email author email instead of using the issue tracker.
75+
76+
## Credits
77+
78+
- [Bhavik Charola](https://github.com/bhavik66)
79+
80+
## License
81+
82+
MIT License. Please see the [license file](LICENSE.md) for more information.
83+
84+
85+
[react_native-badge]: https://img.shields.io/badge/React%20Native-0.57.7-blue.svg?style=flat
86+
[react_native-url]: https://facebook.github.io/react-native/
87+
[android_platform-badge]: https://img.shields.io/badge/Android-4.1+-green.svg
88+
[android_platform-url]: https://developer.android.com/index.html
89+
[android_studio-badge]: https://img.shields.io/badge/Android%20Studio-3.2.1+-green.svg
90+
[android_studio-url]: https://developer.android.com/studio/install

0 commit comments

Comments
 (0)