https://github.com/eskylake/firebase-cloud-messaging-sample
Brief implementation of Firebase Cloud Messaging (FCM) for both client and server, showcasing essential setup and configuration steps.
https://github.com/eskylake/firebase-cloud-messaging-sample
Last synced: 2 months ago
JSON representation
Brief implementation of Firebase Cloud Messaging (FCM) for both client and server, showcasing essential setup and configuration steps.
- Host: GitHub
- URL: https://github.com/eskylake/firebase-cloud-messaging-sample
- Owner: eskylake
- License: mit
- Created: 2024-05-21T12:01:20.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-05-21T12:11:35.000Z (12 months ago)
- Last Synced: 2024-05-21T13:30:48.277Z (12 months ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Firebase Cloud Messaging Sample
Brief implementation of Firebase Cloud Messaging (FCM) for both client and server, showcasing essential setup and configuration steps.
## Installation
1- Make sure to have the following:
- [Service Account](https://firebase.google.com/docs/cloud-messaging/auth-server#provide-credentials-manually)
- [VAPID](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with)
- FCM project & app [Credentials](https://firebase.google.com/docs/web/setup#create-firebase-project-and-app)
2- Replace [`app/server/service-account.json`](https://github.com/eskylake/Firebase-Cloud-Messaging-Sample/blob/main/app/server/service-account.json) with your own
3- Replace [`app/client/firebase-config.json`](https://github.com/eskylake/Firebase-Cloud-Messaging-Sample/blob/main/app/client/firebase-config.json) with your own
4- Replace [`app/client/manifest.json[gcm_sender_id]`](https://github.com/eskylake/Firebase-Cloud-Messaging-Sample/blob/main/app/client/manifest.json) with your FCM `Sender ID`
5- Run the following:
```bash
$ docker compose up -d
# Server listening on port 3000
$ docker exec -t fcm-server yarn run dev
```
## Usage
1- Open [http://localhost](http://localhost) to ensure the client app is working properly.
2- Ensure that Notification permission is allowed and sw.js is successfully registered in the browser.
3- Send a sample notification:
```bash
# Login to the server's container & Send a notification by:
$ docker exec -t fcm-server node cli.js notif
# You can see the usage by:
$ node cli.js notif --help
```
## License
[MIT](https://choosealicense.com/licenses/mit/)