https://github.com/trycourier/courier-flutter
Inbox, Push Notifications & Preferences for Flutter
https://github.com/trycourier/courier-flutter
android apns apple-push-notifications courier fcm firebase-cloud-messaging flutter ios push-notifications
Last synced: 7 days ago
JSON representation
Inbox, Push Notifications & Preferences for Flutter
- Host: GitHub
- URL: https://github.com/trycourier/courier-flutter
- Owner: trycourier
- License: mit
- Created: 2022-09-23T16:36:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-11-20T22:47:49.000Z (6 months ago)
- Last Synced: 2025-11-21T00:16:40.215Z (6 months ago)
- Topics: android, apns, apple-push-notifications, courier, fcm, firebase-cloud-messaging, flutter, ios, push-notifications
- Language: Dart
- Homepage: https://courier.com
- Size: 1.08 MB
- Stars: 11
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Requirements & Support
Requirements
Courier Account
Sign Up
Minimum iOS SDK Version
15.0
Minimum Android SDK Version
23
# Installation
Run the following command at your project's root directory:
```
flutter pub add courier_flutter
```
## **iOS Setup**
### 1. Support iOS 15.0+ in your Project
Update your deployment target to iOS 15
### 2. Install the Cocoapod
From the root of your project run
```sh
cd ios && pod install
```
## **Android Setup**
### 1. Add the Jitpack repository
In your `android/build.gradle` make sure your build and repository values are as follows
```gradle
allprojects {
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' } // Add this line
}
}
```
### 2. Support Proper SDK Version
In your `app/build.gradle` update these values
```gradle
minSdkVersion 23
targetSdkVersion 33+
compileSdkVersion 33+
```
### 3. Gradle Sync
Your app must support at least gradle `8.4`
# Getting Started
These are all the available features of the SDK.
Feature
Description
1
Authentication
Manages user credentials between app sessions. Required if you would like to use Inbox, Push Notifications and Preferences.
2
Inbox
An in-app notification center you can use to notify your users. Comes with a prebuilt UI and also supports fully custom UIs.
3
Push Notifications
Automatically manages push notification device tokens and gives convenient functions for handling push notification receiving and clicking.
4
Preferences
Allow users to update which types of notifications they would like to receive.
5
CourierClient
The base level API wrapper around the Courier endpoints. Useful if you have a highly customized user experience or codebase requirements.
# Example Projects
Project Link
Example
# **Share feedback with Courier**
We want to make this the best SDK for managing notifications! Have an idea or feedback about our SDKs? Here are some links to contact us:
[Courier Flutter Issues](https://github.com/trycourier/courier-flutter/issues)