The schedule trigger and its conditions in the jobs are gone; docs say that a content change needs no rebuild (NFR-10) and that production gets the same only once it is served by the CMS host. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
37 lines
3.4 KiB
Markdown
37 lines
3.4 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 the same CMS host behind an IIS pass-through (planned): the host serves the pages, `/admin` and `/api/v1/*`.
|
|
|
|
## 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 contact form switch.
|
|
- [docs/assets-and-licenses.md](docs/assets-and-licenses.md): where the images, icons and fonts come from and what is still to confirm about their licence.
|
|
- [docs/translations.md](docs/translations.md): where the texts of the site live (language files), how keys work and how a language is added.
|
|
- [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.
|