URL Redirector

A simple and customizable URL redirector that can be hosted on GitHub Pages. This tool reads redirection rules from a JSON file, allowing you to redirect users based on URL fragments (hashes). You can also configure the redirects to display a confirmation popup, providing users with the option to proceed or cancel the redirect.

Hosted as GitHub Pages

This project is hosted using GitHub Pages which allows you to serve your project directly from a GitHub repository. Once you push the project to a GitHub repository, you can configure GitHub Pages to make it accessible to anyone via a public URL.

---

Features

• Dynamic Redirection: Redirect users to custom URLs based on the hash in the URL.
• Popup Confirmation: Optionally show a confirmation popup before redirecting users.
• Background Opening for Bulk URLs: Open multiple URLs in the background, with the last URL loaded into the current tab.
• Customizable Redirect Rules: Easily add, remove, or modify redirect rules in a separate JSON file.
• Responsive and Dark-Themed UI: A clean, user-friendly interface with a modern dark theme.
• Toast Notifications: Non-intrusive feedback for actions, such as URLs being opened.

---

How It Works

1. Redirection Based on URL Hash:

   • When a user visits https://your-site-url.com/#<hash>, the application checks the URL fragment (<hash>).
   • If a matching redirect rule is found in the redirects.json file, the user is redirected accordingly.

2. Popup Confirmation:

   • If configured in the redirects.json file, a popup appears asking if the user wants to proceed to the redirect URL. The user can either click Yes, Redirect or Close Tab.

3. Bulk URL Handling:

   • If multiple URLs are provided in the redirects.json file, they are opened in new tabs in the background. The last URL is loaded in the current tab to ensure smooth single-URL functionality.

4. Customizing Redirect Rules:

   • All redirection rules are stored in a separate redirects.json file. This file contains the hash values (URL fragments) and corresponding URLs. You can also specify whether a popup should appear or not.

---

Project Structure

The project has been split into separate files for better maintainability and customization:

/url-redir
│
├── /css
│   ├── Main.css            # Main CSS for styling the page
│   ├── Source.css          # Additional CSS specific to the Source.html
│
├── /js
│   ├── Main.js             # JavaScript for handling redirection and its logic
│   ├── Source.js           # JavaScript for Source.html logic   
│
├── Code_Appendix.md        # Documentation of Generalized Main HTMLs
├── index.html              # HTML that loads the application
├── redirects.json          # JSON file containing the redirect rules
├── Source.html             # Alternative HTML that shows all present hash links
├── Url-rdr.png             # Image for branding or documentation
└── README.md               # This documentation

---

Code Appendix

This file contains two single HTML files:

1. Redirecting HTML File: A simple HTML file that redirects users to a specified URL after a set time.
2. Redirect Showcase HTML File: A self-contained HTML file that demonstrates various redirect types and showcases how they can be used.

Each file is self-contained with embedded CSS and JavaScript, making them easy to use and share without needing multiple resources.Also add redirects.json as per need.

---

How to Set Up and Use

1. Clone the Repository

To set up this redirector on your own GitHub Pages site:

git clone https://github.com/Runarok/url-redir.git
cd url-redir

2. Update redirects.json

In the redirects.json file, you can add or update redirect rules in the following format:

{
    "SingleRedirect": {
        "url": "https://example.com/single",
        "showPopup": false
    },
    "BulkRedirect": {
        "url": [
            "https://example.com/first",
            "https://example.com/second",
            "https://example.com/third"
        ],
        "showPopup": true
    }
}

• <hash>: The URL fragment used to trigger the redirection (e.g., #SingleRedirect).
• url: The destination URL to redirect to. For bulk redirects, use an array of URLs.
• showPopup: Whether to show a popup before redirecting. Set to true or false.

3. Customize the Look & Feel

• Modify the UI by editing the Main.css and Source.css files.
• Adjust colors, fonts, and other UI elements to fit your needs.

4. Customize the Logic

• The Main.js file contains the primary redirection logic, including handling the URL fragment and showing toast notifications.
• The Source.js file manages the popup logic and URL opening in background tabs.

5. Deploy to GitHub Pages

1. Create a repository on GitHub, and push the url-redir folder to it.
2. In the GitHub repository, go to Settings > Pages.
3. Set the Source to the branch main and the folder to /root.
4. Your site will be live at https://<your-username>.github.io/<your-repo-name>.

---

Features in Detail

Dynamic Redirection

• Based on the fragment in the URL (#hash), the redirector checks for a matching rule in redirects.json.
• If a match is found, the user is either immediately redirected to the target URL or shown a confirmation popup.

Popup Confirmation

• You can configure redirects to show a confirmation dialog before proceeding.
• This feature is controlled via the showPopup field in redirects.json. Set it to true for redirects that need confirmation.

Bulk URL Handling

• For multiple URLs, the tool opens all URLs in new background tabs.
• The last URL in the list will load in the current tab.

Toast Notifications

• Replaces traditional alerts for a smoother user experience.
• Example: After bulk redirects, a toast message like "All URLs have been opened in new tabs" is displayed.

---

Note:
I have linked my redirects URL to this file, which is in another repository. Since I will be archiving this repository, I will continue to use this file as needed.
I will not be updating this repository. I will only modify the redirect.json file for my personal use. Feel free to use the repository as you need!

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---