Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/oracle/llms.txt

Use this file to discover all available pages before exploring further.

Oracle ships as pre-built static files — the compiled JavaScript bundle, CSS, and HTML are already committed to the repository. There is no build step required to view the site locally. All you need is a static file server to serve the repository root over HTTP.

​
Prerequisites

Before getting started, make sure you have the following:
  • Git — to clone the repository
  • Node.js 18+ (optional) — only needed if you want to use npx serve or a Node-based dev server
  • A modern browser — Chrome, Firefox, Safari, or Edge

​
Quick Start

1

Clone the repository

Clone Oracle from GitHub to your local machine:
git clone https://github.com/apursley2012/oracle.git
cd oracle
2

Start a local static file server

Serve the repository root with any static file server. Choose the option that best fits your environment:
# Requires Node.js 18+
npx serve .
# Starts server at http://localhost:3000
3

Open the site in your browser

Navigate to the address shown in your terminal — for example, http://localhost:3000. You should see the Oracle home page with the full animated UI.All navigation routes use hash-based URLs (e.g. http://localhost:3000/#/about), so no server-side routing configuration is necessary.

​
Viewing Specific Pages

Each file in the pages/ directory (e.g. pages/About.html) is a static page shim that enables direct URL access on static hosting platforms. When you navigate to one of these HTML files, it:
  1. Sets window.__STATIC_PAGE_ROUTE__ to the corresponding route path
  2. Rewrites the URL hash to the correct React Router path (e.g. /#/about)
  3. Redirects the browser to index.html with that hash, letting the SPA render the right page
This means you can bookmark or share deep links like /pages/About.html and they will resolve correctly — even on a host that can’t do server-side URL rewriting. In local development the same behaviour applies; visiting http://localhost:3000/pages/About.html will seamlessly land you on the About page.

​
Development Notes

The repository contains only the compiled Vite output — the original source files (.jsx/.tsx, vite.config.js, tailwind.config.js, etc.) are not included. As a result:
  • You cannot run npm run dev for a hot-reloading dev server from this repo
  • You cannot modify component source and rebuild with npm run build
  • To iterate on the UI, use the compiled bundle directly or reconstruct a source project from the build artifacts
For simply viewing, demoing, or deploying the portfolio, a plain static file server is everything you need.
Do not open index.html directly in your browser via the file:// protocol (e.g. by double-clicking the file). Vite’s output uses ES module import statements and modulepreload links, which browsers block under file:// due to CORS restrictions on local files. Always use a local HTTP server (one of the options above) so assets load over http://localhost.

Build docs developers (and LLMs) love

Get started for freeTalk to us