Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alex-friedl/crossplatform-push-notifications-example

Example for crossplatform push notifications with node.js and React Native
https://github.com/alex-friedl/crossplatform-push-notifications-example

apn docker docker-compose fcm fcm-notifications gcm koa2 koajs node-apn node-gcm node-js node-pushnotifications node-pushserver nodejs push-notifications pushnotifications react-native reactnative reactnativedemo

Last synced: 3 months ago
JSON representation

Example for crossplatform push notifications with node.js and React Native

Awesome Lists containing this project

README 

        
# Crossplatform Push-Notifications Demo



This is an example for a Crossplatform Push-Notification setup that works for both Android and iOS.



The example comprises of a server application written in [node.js](https://nodejs.org) that uses the [node-pushnotifications](https://github.com/appfeel/node-pushnotifications) library and a [React Native](https://facebook.github.io/react-native/) app that demonstrates the usage of the [react-native-push-notification](https://github.com/zo0r/react-native-push-notification) library and the [react-native-fcm](https://github.com/evollu/react-native-fcm) library.



It includes an example [Firebase](https://firebase.google.com/) application setup that works out of the box. 

In order to use your own Firebase application, replace the `google-services.json` in the `app/android` directory, respectively the `GoogleService-Info.plist`in the `app/ios`directory with your own (downloadable in the [Firebase Console](https://console.firebase.google.com/)).



## Requirements



- Recommended: [Docker](https://www.docker.com/)

- Optional (if you don't want to use Docker): 

  - [node.js 8.x.x](https://nodejs.org/en/download/current/)

  - [MongoDB](https://docs.mongodb.com/getting-started/shell/installation/)

- Android or iOS development setup (e.g. [Android Studio](https://developer.android.com/studio/index.html))



## Setup



- Optional: Install yarn (`npm install yarn -g`)

- Run `npm install` or `yarn`



## Run demo application



### Start server



- Run `docker-compose up`

- Alternatively:

  - Start MongoDB `mongod --dbpath=`

  - Start server `npm run server`



### Run app  



- Start React Native app packager `npm run app-pkg`

- Connect a device or start a simulator

- Run Android app `npm run android`

- Run iOS app `npm run ios`



## What's happening?



After application startup you should see a screen which displays your device token and the information that no notification has been received yet.



The device token should have been sent to the node.js server and stored in the MongoDB.



In order to send a sample push notification to all known device tokens execute `curl http://localhost:3000/push` or open [http://localhost:3000/push](http://localhost:3000/push) in your local browser.



The application should now display _Last notification title: Crossplatform push is working_.



## Configuration options



### Server



If you choose to run the backend locally without Docker, you can configure two parameters via environment variables:



- _DB\_HOST_: MongoDB host string

- _SERVER\_PORT_: HTTP port of the server application



### App



The app uses the [react-native-config](https://github.com/luggit/react-native-config) library to configure its environment.



You can edit the *app/.env* file in order to configure the following:



- _PUSH\_LIB_: Determines which library will be used. Possible values:

  - *fcm*: Use [react-native-fcm](https://github.com/evollu/react-native-fcm)

  - *rn-push* (actually anything else as well): Use [react-native-push-notification](https://github.com/zo0r/react-native-push-notification)

- SERVER_URL: Base URL of the server application



## Known issues



- Usage of `react-native-push-notification` for iOS currently not functional. Help appreciated.