Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ismaelortega14/node-red-contrib-firebase-cloud-messaging

A simple node that sends messages to the Firebase Cloud Messaging Service of Google to send notifications to a token or a topic.
https://github.com/ismaelortega14/node-red-contrib-firebase-cloud-messaging

firebase firebase-cloud-messaging node-red node-red-contrib

Last synced: 2 days ago
JSON representation

A simple node that sends messages to the Firebase Cloud Messaging Service of Google to send notifications to a token or a topic.

Host: GitHub
URL: https://github.com/ismaelortega14/node-red-contrib-firebase-cloud-messaging
Owner: ismaelOrtega14
License: mit
Created: 2023-12-21T09:40:52.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-05-01T10:01:30.000Z (7 months ago)
Last Synced: 2024-11-16T03:15:46.041Z (3 days ago)
Topics: firebase, firebase-cloud-messaging, node-red, node-red-contrib
Language: JavaScript
Homepage:
Size: 490 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        





[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![Downloads][downloads-shield]][downloads-url]

[![LinkedIn][linkedin-shield]][linkedin-url]





![Version Master][masterVersion-shield]

![Version Development][devVersion-shield]








  

    

    

  

FCM Custom Node


  


    A simple node that sends messages to the Firebase Cloud Messaging Service of Google to send notifications to a token or a topic.

    


    Explore the docs »

    


    


    Report Bug

    ·

    Request Feature

  



## About The Project

![FCM Custom Node Screen Shot][product-screenshot]

This package is used to communicate with Firebase Cloud Messaging. It allows to send messages to the FCM service by token or topic in a simple manner.

(back to top)


### Built With

-   [![NodeJS][Node.js]][Node-url]

-   [![NodeRed][Node-red]][NodeRed-url]

(back to top)


## The Nodes

![FCM Custom Node][customNodes-screenshot]

There are 2 nodes included with this contrib

| Node | Purpose |

| ------------------ | -------------------------------------------------------- |

| FCMConfing | Config node used to store the connection information |

| FCM | Sends messages to FCM |

(back to top)


## How to use?

-   From Manage Palette

Find this package `@iorsan/node-red-contrib-firebase-notification` and click install.

-   Install Manually  

    Rememeber to restart Node RED after using this method.  

    `.node-red` is usually relative to the users home directory that is running Node RED.

```bash

cd ~/.node-red

npm install @iorsan/node-red-contrib-firebase-notification --omit=dev

```

(back to top)


## Authentication Methods

-   `Custom Token` (Generated with Private Key)

(back to top)


## Getting Started Link

-   [Installing][starting-url]: System requirements and install instructions

-   [Generate key][generateKey-url]: How to generate the json key to authenticate

-   [Wiki][wiki-url]: Just about everything

-   [Firebase Site][firebase-url]: What is Firebase?

-   [Change Log](CHANGELOG.md): Whats changed?

(back to top)


## Roadmap

-   [ ] Add testing

-   [ ] Add wiki

    - [ ] Getting started

    - [ ] How to generate a key

    - [ ] How to add params with parse easily

See the [open issues](https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/issues) for a full list of proposed features (and known issues).

(back to top)


## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

(back to top)


## License

Distributed under the MIT License. See [LICENSE][license-url] for more information.

(back to top)


## Contact

Your Name - [email protected]

Project Link: [https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging](https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging)

(back to top)


## Acknowledgments

Put your name here before making a pull request

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging.svg?style=for-the-badge

[contributors-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging.svg?style=for-the-badge

[forks-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/network/members

[stars-shield]: https://img.shields.io/github/stars/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging.svg?style=for-the-badge

[stars-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/stargazers

[issues-shield]: https://img.shields.io/github/issues/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging.svg?style=for-the-badge

[issues-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/issues

[license-shield]: https://img.shields.io/github/license/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging.svg?style=for-the-badge

[license-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/blob/master/LICENSE

[downloads-shield]: https://img.shields.io/npm/dm/@iorsan/node-red-contrib-firebase-cloud-messaging?style=for-the-badge

[downloads-url]: https://www.npmjs.com/package/@iorsan/node-red-contrib-firebase-cloud-messaging?activeTab=versions

[masterVersion-shield]: https://img.shields.io/github/package-json/v/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/master?style=for-the-badge

[devVersion-shield]: https://img.shields.io/github/package-json/v/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/development?style=for-the-badge

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/ismaelortega

[product-screenshot]: images/screenshot.png

[Node.js]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white

[Node-url]: https://nodejs.org/

[Node-red]: https://img.shields.io/badge/Node--RED-%238F0000.svg?style=for-the-badge&logo=node-red&logoColor=white

[NodeRed-url]: https://nodered.org/

[customNodes-screenshot]: images/customNodes.png

[starting-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/wiki/getting-started

[generateKey-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/wiki/generate-key

[wiki-url]: https://github.com/ismaelOrtega14/node-red-contrib-firebase-cloud-messaging/wiki

[firebase-url]: https://firebase.google.com/