store-switcher v1.0.2
App Store Switcher
App Store Switcher is a framework-agnostic utility that automatically redirects site visitors to the appropriate app store based from the OS of their device.
Supported devices at the moment is iOS and Android.
Getting Started
Using the pre-made dist
- Clone this repository
- Contents of the
/distcan be hosted anywhere and is ready for-use.
Building on your own:
- Clone this repository.
- Install dependencies in the project (run
yarnoryarn install,npmornpm installif you're using npm) - Run
yarn build - In the
/distfolder, you'll see the compiled files which you can host anywhere, statically.
Usage
Let's say you've hosted your app in the link example.com, you need to provide 3 link parameters in order for the redirection to work, the required parameters are that links the user to the appropriate store.
Required parameters when visiting example.com
| Parameter | Description | Example |
|---|---|---|
android_appId | Android App ID | com.ubercab of play.google.com/store/apps/details?id=com.ubercab |
apple_developerId | Apple Developer ID | uber of apps.apple.com/us/app/uber/id368677368 |
apple_appId | Apple App ID | id368677368 of apps.apple.com/us/app/uber/id368677368 |
A final link example would be:
example.com/?android_appId=com.ubercab&apple_developerId=uber&apple_appId=id368677368
Behavior
If the device is part of the supported OS, Android/iOS, the static file redirects the user automatically to the appropriate app store, otherwise, a fallback page will be shown. This fallback page contains two badges: Play Store and App Store badges.
Testing:
Simply run yarn:test on the project directory and you're good to go.