Fix SPA routing for GitHub Pages

danielsobrado · danielsobrado · commit 50fc7b354f57 · 2025-11-28T20:51:34.000+04:00
- Add basename to BrowserRouter using import.meta.env.BASE_URL
- Add 404.html for GitHub Pages SPA redirect
- Add redirect script to index.html
diff --git a/unified-app/index.html b/unified-app/index.html
@@ -6,6 +6,23 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>ML Animations - Interactive Machine Learning Visualizations</title>
     <meta name="description" content="Interactive visualizations and animations for machine learning concepts including transformers, attention mechanisms, neural networks, and more." />
+    <!-- Start Single Page Apps for GitHub Pages -->
+    <script type="text/javascript">
+      // Single Page Apps for GitHub Pages
+      // MIT License
+      // https://github.com/rafgraph/spa-github-pages
+      (function(l) {
+        if (l.search[1] === '/' ) {
+          var decoded = l.search.slice(1).split('&').map(function(s) { 
+            return s.replace(/~and~/g, '&')
+          }).join('?');
+          window.history.replaceState(null, null,
+              l.pathname.slice(0, -1) + decoded + l.hash
+          );
+        }
+      }(window.location))
+    </script>
+    <!-- End Single Page Apps for GitHub Pages -->
   </head>
   <body class="antialiased">
     <div id="root"></div>
diff --git a/unified-app/public/404.html b/unified-app/public/404.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>ML Animations</title>
+    <script type="text/javascript">
+      // Single Page Apps for GitHub Pages
+      // MIT License
+      // https://github.com/rafgraph/spa-github-pages
+      // This script takes the current url and converts the path and query
+      // string into just a query string, and then redirects the browser
+      // to the new url with only a query string and hash fragment,
+      // e.g. https://www.foo.tld/one/two?a=b&c=d#qber becomes
+      // https://www.foo.tld/?/one/two&a=b~and~c=d#qber
+      // Note: this 404.html file must be at least 512 bytes for it to work
+      // with Internet Explorer (see this stackoverflow thread
+      // http://stackoverflow.com/questions/7028563/ie-and-custom-404-pages)
+
+      var pathSegmentsToKeep = 1;
+
+      var l = window.location;
+      l.replace(
+        l.protocol + '//' + l.hostname + (l.port ? ':' + l.port : '') +
+        l.pathname.split('/').slice(0, 1 + pathSegmentsToKeep).join('/') + '/?/' +
+        l.pathname.slice(1).split('/').slice(pathSegmentsToKeep).join('/').replace(/&/g, '~and~') +
+        (l.search ? '&' + l.search.slice(1).replace(/&/g, '~and~') : '') +
+        l.hash
+      );
+
+    </script>
+  </head>
+  <body>
+  </body>
+</html>
diff --git a/unified-app/src/main.jsx b/unified-app/src/main.jsx
@@ -5,9 +5,12 @@ import App from './App'
 import { ThemeProvider } from './context/ThemeContext'
 import './index.css'
 
+// Use base path for GitHub Pages deployment
+const basename = import.meta.env.BASE_URL
+
 ReactDOM.createRoot(document.getElementById('root')).render(
   <React.StrictMode>
-    <BrowserRouter>
+    <BrowserRouter basename={basename}>
       <ThemeProvider>
         <App />
       </ThemeProvider>
