Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/digital-coven/llms.txt

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

Digital Coven is a Vite-powered React SPA, so the full local development workflow — from a fresh clone to a live browser preview — takes less than two minutes. The build system is standard Vite with no custom server configuration required; all you need is Node.js 18 or later and a package manager of your choice.

​
Prerequisites

Before you begin, make sure the following are available in your environment:
  • Node.js 18+ — Vite’s minimum supported version. Run node -v to check.
  • npm, yarn, or pnpm — any of the three work without additional configuration.
  • Git — to clone the repository.
The project was built and tested with Node.js 20 LTS. If you see peer-dependency warnings on older Node.js versions, upgrade to 20 LTS for the smoothest experience.

​
Full Setup Walkthrough

1

Clone the repository

Pull the project from GitHub to your local machine:
git clone https://github.com/apursley2012/digital-coven.git
cd digital-coven
2

Install dependencies

Install all required packages. Choose the package manager you prefer — all three produce equivalent results:
npm install
3

Start the development server

Launch Vite’s dev server with hot module replacement enabled:
npm run dev
Vite starts on port 5173 by default. Open http://localhost:5173 in your browser to see the full animated portfolio.
Because the app uses hash-based routing, the inline script in index.html will automatically redirect http://localhost:5173 to http://localhost:5173/#/ on first load. This is expected behaviour — not an error.
4

Build for production

When you’re ready to produce a deployable artefact, run:
npm run build
Vite bundles and minifies the application into the dist/ directory. The output includes index.html, the pre-built assets/main.js and assets/main.css, and all pre-loaded component modules.
5

Preview the production build

Before deploying, serve the dist/ output locally with Vite’s built-in preview server to verify the production bundle behaves identically to the dev server:
npm run preview
The preview server also starts on port 4173 by default. Visit http://localhost:4173 to confirm everything looks correct.

​
Deploying to GitHub Pages

Digital Coven is configured for zero-configuration deployment to GitHub Pages or any static file host. Two mechanisms make this work:
  1. .nojekyll — A .nojekyll file is committed at the repository root. This tells GitHub Pages to skip Jekyll processing, which would otherwise strip files whose names begin with an underscore (including Vite’s _ prefixed chunk files).
  2. Hash-routing redirect script — index.html contains the following inline script that runs before React mounts: 
    <script>
  window.__STATIC_PAGE_ROUTE__ = "/";

  (function () {
    if (!window.location.hash || window.location.hash === "#") {
      window.location.replace(
        window.location.pathname +
        window.location.search +
        "#/"
      );
    }
  })();
</script>
    Because all navigation is hash-prefixed (/#/about, /#/projects, etc.), the static host only ever needs to serve the single index.html file — no server-side rewrite rules or 404.html tricks are required.
After running npm run build, copy the contents of dist/ (including .nojekyll) to your GitHub Pages branch or static hosting root. The app will serve correctly from any path depth.

​
Available Scripts

CommandDescription
npm run devStart Vite dev server on localhost:5173 with HMR
npm run buildBundle and minify to dist/
npm run previewServe dist/ locally on localhost:4173

Build docs developers (and LLMs) love

Get started for freeTalk to us