|
16 | 16 |
|
17 | 17 | OneSignal makes engaging customers simple and is the fastest, most reliable service to send push notifications, in-app messages, SMS, and emails. |
18 | 18 |
|
19 | | -This project demonstrates how to send a push notification from a [Supabase Edge Function](https://supabase.com/docs/guides/functions). Use this sample integration as a reference for your own edge function implementation. |
| 19 | + |
| 20 | + |
| 21 | +This project demonstrates how to use OneSignal as an integration with [Supabase](https://supabase.com) to handle your messaging needs, including push notifications, SMS text messages, email, and in-app messaging. Feel free to use this sample as a reference for your own Supabase integration. |
| 22 | + |
| 23 | +###### Current OneSignal channels Implemented |
| 24 | + |
| 25 | +- [x] Mobile Push Notifications |
| 26 | +- [ ] Web Push Notifications (planned) |
| 27 | +- [ ] SMS Text Messages (planned) |
| 28 | +- [ ] Email (planed) |
| 29 | +- [x] In-app Messages |
| 30 | + |
| 31 | +--- |
20 | 32 |
|
21 | 33 | ## 🚦 Getting started |
22 | 34 |
|
23 | 35 | This project assumes that you already have a few things setup. |
24 | 36 |
|
25 | | -- [OneSignal app](https://documentation.onesignal.com/docs/apps-organizations#create-an-app) created. |
26 | | -- [Android](https://documentation.onesignal.com/docs/android-sdk-setup) or [iOS](https://documentation.onesignal.com/docs/ios-sdk-setup) app integrated with a [OneSignal SDK](https://github.com/onesignal/sdks). |
27 | | -- [Supabase CLI](https://supabase.com/docs/guides/cli#installation) [v1.14.0](https://www.npmjs.com/package/supabase/v/1.14.0) installed. |
| 37 | +- An existing OneSignal account. If not, [create one for free](https://dashboard.onesignal.com/signup). |
| 38 | +- A Supabase account and the [Supabase CLI](https://supabase.com/docs/guides/cli#installation) [v1.16.0](https://www.npmjs.com/package/supabase/v/1.16.0) installed. |
| 39 | +- A Firebase account, if not [create one first](https://firebase.google.com/). |
| 40 | +- A Stripe account and the [Stripe CLI](https://stripe.com/docs/stripe-cli) v1.13.5 installed. |
| 41 | +- A Vercel account and the [Vercel CLI](https://vercel.com/docs/cli#) [v28.7.0](https://www.npmjs.com/package/vercel/v/28.7.0) installed (or anything capable of hosting a Next.js API). |
| 42 | +- A working Flutter dev environment and access to a mac for iOS-specific steps. |
28 | 43 | - [Deno](https://github.com/denoland/deno_install) v1.28.0 installed. |
29 | 44 |
|
30 | | ---- |
31 | | - |
32 | 45 | ## Setup OneSignal App |
33 | 46 |
|
| 47 | +1. From the OneSignal Dashboard, select **New App/Website** to create an app. |
| 48 | + |
| 49 | +2. Name app and choose the **Android** platform to setup.  |
| 50 | +3. Enter FCM credentials for the Firebase project you want to handle Android notifications and choose **Save & Continue**.  |
| 51 | + |
34 | 52 | ### Setup iOS Platform |
35 | 53 |
|
36 | | -### Setup Android Platform |
| 54 | +iOS configuration requires substantially more effort to integrate due to needing signed certs from Apple. Due to this fact, follow [this guide](https://github.com/OneSignalDevelopers/OneSignal-Flutter-Sample/blob/main/docs/obtaining-ios-push-cert.md) for detailed instructions on creating the certificate needed to use Apple's Push Notification Service ([APNs](https://developer.apple.com/documentation/usernotifications/registering_your_app_with_apns)). |
| 55 | + |
| 56 | +After you have the certificate, head to the OneSignal Dashboard |
| 57 | + |
| 58 | +1. Choose **Settings -> Platforms** |
| 59 | +2. **Activate** the iOS card |
| 60 | + |
| 61 | +3. Upload your certificate and enter the password you used to encrypt it. If you didn't set a password, leave the password input blank.  |
37 | 62 |
|
38 | 63 | ### Craft an In-App Message |
39 | 64 |
|
|
0 commit comments