Skip to content

Commit

Permalink
docs: add push notification installation explanations
Browse files Browse the repository at this point in the history
  • Loading branch information
santhoshvai committed Sep 26, 2024
1 parent 4480ba0 commit a2a0ec9
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@ Please follow the below guides for adding appropriate push providers to Stream:
```bash title=Terminal
yarn add @react-native-firebase/app
yarn add @react-native-firebase/messaging
yarn add @notifee/react-native
yarn add react-native-callkeep
yarn add react-native-voip-push-notification
yarn add @notifee/react-native
npx pod-install
```

So what did we install precisely?

- `@react-native-firebase/app` and `@react-native-firebase/messaging` for handling incoming [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) notifications on Android.
- `@notifee/react-native` - is used to customize and display push notifications.
- `react-native-voip-push-notification` for handling incoming [PushKit](https://developer.apple.com/documentation/pushkit) notifications on iOS.
- `react-native-callkeep` for reporting incoming calls to iOS [CallKit](https://developer.apple.com/documentation/callkit).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,17 @@ Please follow the below guides for adding appropriate push providers to Stream:
```bash title=Terminal
npx expo install @react-native-firebase/app
npx expo install @react-native-firebase/messaging
npx expo install react-native-voip-push-notification
npx expo install react-native-callkeep
npx expo install @notifee/react-native
npx expo install react-native-voip-push-notification
npx expo install react-native-callkeep @config-plugins/react-native-callkeep
```

So what did we install precisely?

- `@react-native-firebase/app` and `@react-native-firebase/messaging` for handling incoming [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) notifications on Android.
- `@notifee/react-native` - is used to customize and display push notifications.
- `react-native-voip-push-notification` for handling incoming [PushKit](https://developer.apple.com/documentation/pushkit) notifications on iOS.
- `react-native-callkeep` for reporting incoming calls to iOS [CallKit](https://developer.apple.com/documentation/callkit).
- `react-native-callkeep` and `@config-plugins/react-native-callkeep` for reporting incoming calls to iOS [CallKit](https://developer.apple.com/documentation/callkit).

## Add Firebase credentials

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,15 @@ Please follow the below guides for adding appropriate push providers to Stream:
```bash title=Terminal
yarn add @react-native-firebase/app
yarn add @react-native-firebase/messaging
yarn add @react-native-community/push-notification-ios
yarn add @notifee/react-native
yarn add @react-native-community/push-notification-ios
npx pod-install
```

So what did we install precisely?

- `@react-native-firebase/app` and `@react-native-firebase/messaging` for handling incoming [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) notifications on Android.
- `@notifee/react-native` - is used to customize and display push notifications.
- `@react-native-community/push-notification-ios` for handling [Apple Push Notification service (APNs)](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns) notifications on iOS.

## Android-specific setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ npx expo install @notifee/react-native
So what did we install precisely?

- `expo-notifications` and `expo-task-manager` for handling incoming [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging) notifications on Android and iOS.
- `@notifee/react-native` - is used to customize and display push notifications.

## Add Firebase credentials

Expand Down

0 comments on commit a2a0ec9

Please sign in to comment.