Skip to content

Commit 03afa49

Browse files
MeldironMeldiron
authored
Merge pull request #17 from appwrite/feat-push-notifications-with-fcm
feat: Push Notifications with FCM function
2 parents 0cf0833 + a6c5baa commit 03afa49

9 files changed

Lines changed: 2501 additions & 3 deletions

File tree

‎kotlin/starter/.gitignore‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,6 @@ captures/
5252
# External native build folder generated in Android Studio 2.2 and later
5353
.externalNativeBuild
5454

55-
# Google Services (e.g. APIs or Firebase)
56-
google-services.json
57-
5855
# Freeline
5956
freeline.py
6057
freeline/

‎node/push-notification-with-fcm/.gitignore‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*

‎node/push-notification-with-fcm/.prettierrc.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"trailingComma": "es5",
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true
6+
}

‎node/push-notification-with-fcm/README.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# 🔔 Node.js Push Notifications with FCM Function
2+
3+
Send push notifications to your users using Firebase Cloud Messaging (FCM).
4+
5+
## 🧰 Usage
6+
7+
### `POST`
8+
9+
Send a push notification to a user.
10+
11+
**Parameters**
12+
13+
| Name | Description | Location | Type | Sample Value |
14+
| ------------ | ------------------------------------ | -------- | ------------------ | -------------- |
15+
| Content-Type | The content type of the request body | Header | `application/json` | N/A |
16+
| deviceToken | FCM device identifier | Body | String | `642...7cd` |
17+
| message | Message to send | Body | String | `Hello World!` |
18+
19+
**Response**
20+
21+
Sample `200` Response:
22+
23+
```json
24+
{
25+
"ok": true,
26+
"messageId": "as4jg109cbe1"
27+
}
28+
```
29+
30+
Sample `400` Response:
31+
32+
```json
33+
{
34+
"ok": false,
35+
"error": "Device token and message are required."
36+
}
37+
```
38+
39+
Sample `500` Response:
40+
41+
```json
42+
{
43+
"ok": false,
44+
"error": "Failed to send the message."
45+
}
46+
```
47+
48+
## ⚙️ Configuration
49+
50+
| Setting | Value |
51+
| ----------------- | ------------- |
52+
| Runtime | Node (18.0) |
53+
| Entrypoint | `src/main.js` |
54+
| Build Commands | `npm install` |
55+
| Permissions | `any` |
56+
| Timeout (Seconds) | 15 |
57+
58+
## 🔒 Environment Variables
59+
60+
### FCM_PROJECT_ID
61+
62+
A unique identifier for your FCM project.
63+
64+
| Question | Answer |
65+
| ------------- | -------------------------------------------------------------------------------------------------- |
66+
| Required | Yes |
67+
| Sample Value | `mywebapp-f6e57` |
68+
| Documentation | [FCM: Project ID](https://firebase.google.com/docs/projects/learn-more#project-id) |
69+
70+
### FCM_CLIENT_EMAIL
71+
72+
Your FCM service account email.
73+
74+
| Question | Answer |
75+
| ------------- | -------------------------------------------------------------------------------------------------- |
76+
| Required | Yes |
77+
| Sample Value | `fcm-adminsdk-1a0de@test-f6e57.iam.gserviceaccount.com` |
78+
| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |
79+
80+
### FCM_PRIVATE_KEY
81+
82+
A unique private key used to authenticate with FCM.
83+
84+
| Question | Answer |
85+
| ------------- | -------------------------------------------------------------------------------------------------- |
86+
| Required | Yes |
87+
| Sample Value | `0b6830cc66d92804e11af2153242d34211d675675` |
88+
| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |
89+
90+
### FCM_DATABASE_URL
91+
92+
URL of your FCM database.
93+
94+
| Question | Answer |
95+
| ------------- | -------------------------------------------------------------------------------------------------- |
96+
| Required | Yes |
97+
| Sample Value | `https://my-app-e398e.firebaseio.com` |
98+
| Documentation | [FCM: SDK Setup](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments) |

‎node/push-notification-with-fcm/env.d.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
declare global {
2+
namespace NodeJS {
3+
interface ProcessEnv {
4+
FCM_PROJECT_ID: string;
5+
FCM_CLIENT_EMAIL: string;
6+
FCM_PRIVATE_KEY: string;
7+
FCM_DATABASE_URL: string;
8+
}
9+
}
10+
}
11+
12+
export {};

0 commit comments

Comments
 (0)