rafgraph/spa-github-pages
Spa Github Pages
This project is a client-side routing solution and URL manager designed for single-page applications hosted on static platforms, specifically GitHub Pages. It enables these applications to handle deep links and maintain functional routing on hosts that do not support server-side redirects.
The system intercepts server-side 404 errors and redirects them to a main entry point, using query strings and hash fragments to preserve the application state and restore the original intended path. It also includes utilities for generating specialized, redirect-compatible links for sitemaps to ensure search engines can index pages without triggering server-side errors.
The project provides comprehensive support for route management, URL state preservation, and search engine optimization for static site environments.
Features
- 404 Page Redirections - Intercepts static host 404 errors and redirects them to the root to enable client-side routing.
- URL Parameter Persistence - Ensures the browser maintains the correct path and query parameters when redirecting back to the main entry point.
- Client-side Routing - Provides a mechanism to intercept missing page requests and redirect them to maintain application state.
- Fragment Preservation - Maintains URL hash fragments and query parameters during redirects to ensure the correct application view loads.
- Route Redirects - Provides utilities to redirect server-side errors on static hosts back to the main entry point.
- Static Route Interception - Uses a custom fallback page to simulate dynamic routing on a platform that only supports static files.
- Static Site Error Pages - Intercepts 404 errors on static hosts to preserve application state and redirect users to the home page.
- Static SPA Routers - Provides a client-side routing solution that enables single page applications to handle deep links on GitHub Pages.
- Client-Side URL Rewriters - Encodes destination paths in query strings to bypass server-side routing limitations on static platforms.
- URL State Restoration - Reroutes missing page requests to a main entry point using query strings to recover the original application state.
- Single Page Application Hosting - Implements fallback routing to serve a single HTML file for all application paths on static hosts.
- SPA Routing Configurations - Enables hosting of single page applications on GitHub Pages while maintaining functional client-side routing.
- Sitemap Redirects - Transforms standard URLs into redirect-compatible links for sitemaps to enable indexing despite server-side errors.
- Static Site SEO - Creates search engine friendly links for single page apps hosted on platforms without server-side redirects.
- Sitemap Generators - Generates search engine friendly links that function correctly on static hosting services.
- Redirect-Compatible Sitemaps - Generates specialized sitemap URLs that bypass server-side errors by encoding the intended destination path.
- SEO Link Encoding - Transforms standard paths into specialized links that bypass server-side errors for search engine indexing.
