Skip to content

glauber-FullStackDev/pushNotificationBack_withFCM

Repository files navigation

Sending Push Notifications using the FCM service (Firebase) - NodeJS - Back-End Modul

This project aims to facilitate the configuration of a push notification sending system, standardizing an endpoint structure - Using FCM (FIREBASE).

Alt text


Requirements

For development, you will only need Node.js and a node global package, Yarn, installed in your environement.

Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    $ sudo apt install nodejs
    $ sudo apt install npm
    
  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website.

If the installation was successful, you should be able to run the following command.

$ node --version
v8.11.3

$ npm --version
6.1.0

If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

$ npm install npm -g

Yarn installation

After installing node, this project will need yarn too, so just run the following command.

  $ npm install -g yarn

Install

$ git clone https://github.com/glauber-FullStackDev/pushNotificationBack_withFCM.git
$ cd pushNotificationBack_withFCM
$ yarn install

Configure app

Open src/keys/onDoctKey.json and replace the data with your Firebase credentials

Running the project

$ yarn start

Endpoints

/pushNotification/sendSingle

- REQUEST

body = { "title": "title of push notification", "body": "body of push notification", "token": "token fcm - is generated by the FCM front plugin" }

- RESPONSE - STATUS 200

{ "error": false, "data": "success" }

- ERROR - STATUS 400

{ error: true, data: err }

/pushNotification/sendMult

- REQUEST

body = { "title": "title of push notification", "body": "body of push notification", "token": "array of tokens fcm - is generated by the FCM front plugin" }

- RESPONSE - STATUS 200

{ "error": false, "data": "success" }

- ERROR - STATUS 400

{ error: true, data: err }

About

Esse projeto visa facilitar a configuração de um sistema de envio de push notification, padronizando uma estrutura de endpoints - Utilizando o FCM (FIREBASE)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors