simple-redirect/README.md

26 lines
1.3 KiB
Markdown
Raw Normal View History

2023-07-23 22:41:34 +08:00
# A simple web redirect to allow users to open links in-app
2023-07-23 21:25:39 +08:00
2023-07-23 22:54:18 +08:00
Since Gmail forbids pop-ups redirecting to app links in email attachments, I've decided to create an app to help me with that.
2023-07-23 22:53:19 +08:00
## Sample Usage
2023-07-23 21:25:39 +08:00
2023-07-23 22:45:48 +08:00
When a user creates an account, an email is sent which redirects to the link below
https://lemeow125.github.io/simple-redirect/#/redirect/stude/activation/MUID/12asdSDFGSDTSDFG
2023-07-23 21:25:39 +08:00
2023-07-23 22:58:30 +08:00
The link above when clicked will open another link
2023-07-23 22:53:19 +08:00
stude://activation/MUID/12asdSDFGSDTSDFG
2023-07-23 22:59:09 +08:00
This link will open the "activation" page/screen of our mobile app, pass the UID slug value of "MUID" and activation slug value of "12asdSDFGSDTSDFG", thus allowing the user to activate his/her account without needing a dedicated web app
2023-07-23 22:53:19 +08:00
## Notes
2023-07-23 21:25:39 +08:00
2023-07-23 22:53:19 +08:00
- You should have Linking properly set up in your mobile app
- Do not change the "redirect" keyword in the URL
- "stude" in the example above must correspond to the name of your mobile app
- "activation" should correspond to the link to your mobile app's screen/page
- You can adjust the last two URL slugs/values according to your needs
2023-07-23 23:26:14 +08:00
- simple-redirect does not allow HTTP/HTTPS redirects for security reasons. If you wish to enable it, fork this repository, change forbid_http_links to false in App.tsx, and deploy it to Github pages on your own account
2023-07-23 21:25:39 +08:00
2023-07-23 22:53:19 +08:00
#### Powered by Vite, ReactJS, and React Router