Files
AndreaSlopFotografie/README.md
T
SluijsensandClaude Sonnet 5.5 6ff415e1bc Documents the CMS packages, banners, deploy flow and go-live conditions
Adds docs/cms-integration.md, docs/deploy-and-ci.md and
docs/go-live-checklist.md, fills in the README (set-up and commands) and
points AGENTS.md at the docs so they are kept up to date.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-15 00:07:51 +01:00

35 lines
3.0 KiB
Markdown

# Andrea Slop Fotografie
Photography website made with .NET and React for Andrea Slop Fotografie. The site (in [web/](web/)) is a React single-page app (Vite, TanStack Start prerendering, Chakra UI v3) that is prerendered to static HTML at build time. On the test host it is served by the SLP CMS host (.NET), on production by IIS (planned).
## Set-up
### Pre-requisites
- Node.js 24 and pnpm (run every command in [web/](web/)).
- Chrome for the end-to-end checks (`pnpm e2e` uses the installed Chrome; CI uses Playwright's Chromium).
### Commands (in `web/`)
| Command | What it does |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pnpm install` | Installs the dependencies (also generates the Chakra types). |
| `pnpm dev` | Dev server. Set `API_PROXY_TARGET` (for example the ASF test host) to forward `/api` to a CMS host, so the contact form and the live packages work. |
| `pnpm build` | Fetches the packages and banners from the CMS (see [docs/cms-integration.md](docs/cms-integration.md)), type-checks, builds and prerenders into `dist/`. |
| `pnpm preview` | Serves `dist/` like the host does (headers, redirects). `--contact-stub` answers the contact and offerings API with a stub, as CI does. |
| `pnpm test` | Unit, component, property and axe tests with coverage (100% required for `src/lib/**`). |
| `pnpm e2e` | Real-browser checks against a built `dist/`. |
| `pnpm check` | Everything CI runs: lint, format, tests, build, e2e, audit and Lighthouse. |
| `pnpm server-config` | Regenerates `web/deploy/iis/web.config` and `web/deploy/nginx/*.conf`. Do not edit those by hand. |
## Lay-out
Lay-out of the website and its pages can be found in a separate document [LAYOUT.md](LAYOUT.md).
## Documentation
- [docs/cms-integration.md](docs/cms-integration.md): packages and banners from the CMS, the API, the build step, live refresh and the reverse proxy.
- [docs/deploy-and-ci.md](docs/deploy-and-ci.md): the pipeline, the workflow inputs, deploying to test, the nightly build and the TEST ONLY commit.
- [docs/go-live-checklist.md](docs/go-live-checklist.md): what must be true before the CMS features and the contact form go to production.
- [aidlc-docs/](aidlc-docs/): the AI-DLC records per feature (requirements, design, decisions, audit). [aidlc-docs/active-features.md](aidlc-docs/active-features.md) lists them.