Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enzoferey/url-to-deep-link
Transform URLs to Deep Links and open your users apps
https://github.com/enzoferey/url-to-deep-link
Last synced: 3 months ago
JSON representation
Transform URLs to Deep Links and open your users apps
- Host: GitHub
- URL: https://github.com/enzoferey/url-to-deep-link
- Owner: enzoferey
- License: mit
- Created: 2018-08-01T10:02:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T10:48:23.000Z (5 months ago)
- Last Synced: 2024-10-15T15:18:23.514Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 939 KB
- Stars: 13
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# url-to-deep-link
[](https://travis-ci.org/enzoferey/url-to-deep-link)
Transform URLs to Deep Links and open your users apps
#### Why ?
Deep links are a very powerful feature of Android and iOS devices that allows creators to point their users to the content with the best experience possible.
Looking for a way to redirect users throught a basic `` html link tag, I found out that no library does the conversion from a URL to a deep link. There was an [attempt](https://github.com/hampusohlsson/browser-deeplink) 4 years ago that wasn't still what I was looking for and [another one](https://github.com/mderazon/node-deeplink) more recent but that works using a Node server and still doesn't exactly do what I was looking for: just transform URLs to deep links.
Following on with the research some services like [Branch.io](https://branch.io/) and [Url Geni](https://app.urlgeni.us/) exist but they are premium. Branch is hard to try because you need to request a demo, which I asked for but I haven't got any answer back yet. On the other hand Url Geni gives you a quick way to see it working in their home page and later on with a subscription you are able to generate URLs dinamically using their API.
Since [universal links](https://developer.apple.com/ios/universal-links/) are still not a standard nor all the apps support them nor all version of Android and iOS support them, I decided to create this library.
`url-to-deep-link` is a simple hardcoded solutions that translates URLs to their deep link version in order to open your users apps.
## Install
`npm install --save url-to-deep-link`
## Usage
```js
// ES5 require syntax also works
// var getAndroidDeepLink = require("url-to-deep-link").getAndroidDeepLink;
import { getAndroidDeepLink, getIOSDeepLink } from "url-to-deep-link";
const yourAndroidDeepLink = getAndroindDeepLink("YOUR URL");
const yourIOSDeepLink = getIOSDeepLink("YOUR URL");
```
At this moment the following transformations are available (any other option will return `undefined`):
### Facebook
- **Page**: `https://www.facebook.com/YOUR_PAGE_ID`
You can get your id [here](https://findmyfbid.com/).
### Instagram
- **Profile**: `https://www.instagram.com/YOUR_USERNAME`
- **Post** (ONLY ANDROID): `https://www.instagram.com/p/YOUR_POST_ID`
### Twitter
- **Profile**: `https://www.twitter.com/YOUR_USERNAME`
- **Tweet**: `https://twitter.com/YOUR_USERNAME/status/YOUR_TWEET_ID`
## Notes
Facebook URL transformation by page name instead of ID and Instagram's post URL on iOS are not suported because they require an asynchronous call in order to get the ID of the page/post. In [`./lib/apps/facebook.js`](./lib/apps/facebook.js) you can find an async version commented working fine although Facebook apps are currently a mess and there is no way to get an API access token.
## Test
`npm run test`
## Build (webpack)
`npm run build`
## License
MIT