-
Notifications
You must be signed in to change notification settings - Fork 198
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Ionic Capacitor example app #992
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Ionic Capacitor - React Framework
Includes basic initialization with logging and push permission prompting. The OneSignal plugin is added as a linked dependency in this repo, facilitating more efficient testing of SDK changes. IMPORTANT: Updating vite.config is necessary for the app to build. source: https://vitejs.dev/guide/dep-pre-bundling.html#monorepos-and-linked-dependencies
- create iOS blank app - install OneSignal plugin - update bundle ID - add Push & Background Modes capabilities
- React functionality closely resembles React Native example app - Update rendering for Ionic
- include demo project information - update supported Android/iOS versions
jennantilla
requested review from
jkasten2,
iAmWillShepherd,
nan-li,
emawby,
jinliu9508 and
shepherd-l
May 9, 2024 17:44
iAmWillShepherd
approved these changes
May 9, 2024
Create new bundle ID
nan-li
approved these changes
May 15, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
One Line Summary
Add Ionic Capacitor example app
Details
Motivation
Unlike many of our other repos, Cordova does not have an integrated example app. This means that currently, any testing for the SDK must be done by linking/unlinking the changing repo to a separate standalone app. The demo apps provided in the README are limited in terms of method functionality and are out-of-date (Player Model). Further, since test apps are not directly linked to the SDK, a fair bit of set up is required on the tester side to get started.
Adding an integrated example app with User Model methods and an automatic linked dependency to the SDK will allow for a seamless test experience for further Cordova SDK development.
The Ionic Capacitor React framework (vs. Cordova) was chosen due to its more widespread use from our customers as well as its enhanced native functionality and robust product support. Additionally, since this example app uses React, updating it will be very similar to the existing React Native app, which will aid in app maintenance and reduce context switching while testing between the two SDKs.
Scope
A new directory,
/examples
has been added to the Cordova SDK.From this directory, the example app can be opened by running:
Testing
Manual testing
Functional testing of the added method buttons was completed on both an iOS 17.2 simulator as well as an Android 14 Emulator.
iOS
Android
Affected code checklist
Checklist
Overview
Testing
Final pass
This change is