Welcome to the Shorebird Samples repository! This is a collection of sample applications and demonstrations showcasing how to integrate and use Shorebird across various real-world Flutter architectures.
Shorebird provides instant over-the-air (OTA) updates for Flutter apps, allowing you to push code changes directly to users' devices without going through traditional app store review cycles.
Below is a list of the available samples. Each directory contains a specific use case or architectural pattern.
| Sample | Description |
|---|---|
| Flavors | Demonstrates how to configure Shorebird in a Flutter app that uses standard flavors. |
| Multi-Dimensional Flavors | A more advanced setup showcasing Shorebird with multiple, multi-dimensional flavors on Android. |
| Add-to-App | Shows how to seamlessly patch a Shorebird Flutter module embedded inside a native Android or iOS application. |
| Progressive Rollout Demo | Illustrates how to mitigate risk by performing percentage-based patch rollouts using Shorebird tracks. |
| Shorebird Fintech Wallet | An enterprise-grade example of a logic-level hotfix using a decoupled Reactive Store + BLoC architecture. |
- Install Shorebird: If you haven't already, install the Shorebird CLI by following the getting started guide.
- Explore a Sample: Navigate into any of the sample directories above.
- Read the Docs: Each sample contains its own
README.mdwith specific instructions on how to run and test it.
We welcome contributions! If you have an interesting use case or architecture you'd like to demonstrate with Shorebird, feel free to open a Pull Request.