# Quick Start Guide

Fast path to run, test, and deploy the Miracles in Motion public site.

## 1. Prerequisites

| Tool | Version | Notes |
|------|---------|-------|
| Node.js | 22.x | CI and local dev |
| npm | 10+ | Use `npm ci` (`.npmrc` sets `legacy-peer-deps`) |
| ImageMagick | any recent | Required for `npm run brand:export` / `prebuild` |
| Git | latest | |

Production deploy additionally requires LAN access to Proxmox — see [PROXMOX_DEPLOYMENT.md](./deployment/PROXMOX_DEPLOYMENT.md).

## 2. Clone & install

```bash
git clone https://github.com/Order-of-Hospitallers/miracles_in_motion.git
cd miracles_in_motion
npm ci
```

## 3. Environment

Copy `.env.example` to `.env.local` (do not commit secrets):

```env
VITE_API_BASE=/api
VITE_STRIPE_PUBLISHABLE_KEY=pk_test_xxx
VITE_DEFAULT_LANGUAGE=en
```

## 4. Run locally

```bash
npm run dev
# http://localhost:5173
```

## 5. Test & validate

```bash
npm test                      # unit tests (Vitest)
npm run type-check            # tsc --noEmit
npm run a11y:header-audit     # WCAG header contrast tokens
npm run validate:ci           # all three above
```

## 6. Production build

```bash
npm run build
# output: dist/
npm run preview               # optional local preview
```

## 7. Deploy to mim4u.org (Proxmox)

From the **proxmox** repo on operator LAN:

```bash
./scripts/mim4u-deploy-to-7810.sh
```

Verify:

```bash
curl -I -H 'Host: mim4u.org' http://192.168.11.37/
```

## 8. CI

GitHub Actions runs on PR (`validate.yml`) and main push (`deploy.yml`). See [DEPLOYMENT_PREREQUISITES.md](./DEPLOYMENT_PREREQUISITES.md).