Hunters SPA

Personal portfolio SPA built with React, TypeScript, Mantine, and GitHub Pages deployment.

Tech Stack

• React 18 + TypeScript
• Create React App (react-scripts)
• Mantine UI
• React Router (HashRouter for GitHub Pages compatibility)
• Jest + React Testing Library

Prerequisites

• Node.js 18+ (Node 20 recommended)
• npm (this repo is standardized on npm)

Setup

Install dependencies:

npm install --legacy-peer-deps

The --legacy-peer-deps flag is currently required due existing peer dependency constraints in the dependency tree.

Run Locally

npm start

App runs at http://localhost:3000.

Scripts

• npm start: Run development server.
• npm run build: Build production bundle to build/.
• npm run deploy: Deploy build/ to GitHub Pages.
• npm test: Run tests in watch mode.
• npm run test:ci: Run tests once for CI usage.
• npm run lint: Lint TypeScript/TSX sources.
• npm run typecheck: Run TypeScript compiler checks.
• npm run format: Apply Prettier formatting.
• npm run format:check: Verify formatting.
• npm run check: Run lint + typecheck + CI tests.

CI

GitHub Actions workflow is configured at .github/workflows/ci.yml and runs:

• dependency install
• npm run check
• npm run build

Project Structure

• src/Components: reusable UI components
• src/Pages: top-level routed pages
• src/DynamicPages: dynamic route views
• src/Data: static content/data modules
• src/styles: shared styling tokens/helpers

Deployment

This project uses gh-pages and homepage in package.json.

Deploy with:

npm run deploy