A prototype public gallery for the software, data, and models built at the Institute of Environmental Sciences (CML), Leiden University, so colleagues can showcase their work in one place.
Live demo: cmlplatform.github.io/cml-gallery
Proposal-stage prototype. Built to demonstrate an approach for discussion with the institute. It is not an official CML site, and the gallery holds its first five entries.
Contribution should be as cheap as possible. Adding a project is one templated Markdown file and a pull request — no CMS, no login, no touching the site's code. The site stays low-maintenance, and every change goes through normal Git review.
The file is the contract: each entry is validated at build time against a typed
schema (src/lib/entry.ts), so a malformed entry
fails the build with a clear message instead of shipping a broken card.
Copy _TEMPLATE.md, fill it in, open a PR.
Full instructions: CONTRIBUTING.md.
Requires Node 24+: the tests and the ingest script import TypeScript
directly, which Node 22.12 cannot do without a flag. CI runs Node 26.
Install pnpm before running the commands below.
The packageManager field pins pnpm 12.18.0 for local development and CI.
The @emnapi/runtime development dependency keeps Astro's checker on the same
1.x runtime as its WebAssembly bridge.
pnpm install --frozen-lockfile
pnpm run dev # dev server with hot reload
pnpm run build # production build to dist/ — also validates every entry
pnpm run preview # serve the production build
pnpm run check # astro check (types)
pnpm test # unit tests
pnpm run og-card # re-render public/og.png, the social card, from docs/og-card/
pnpm run test:a11y # axe on the built site; needs `pnpm run build`, `pnpm exec astro preview` and `pnpm exec playwright install chromium`| Path | What it is |
|---|---|
src/lib/entry.ts |
The Zod schema — the ingestion contract, shared by the site and the ingest script. |
src/content/projects/ |
One Markdown file per project. _TEMPLATE.md is the template. |
src/pages/index.astro |
Landing page: searchable, filterable project list. |
src/pages/projects/[slug].astro |
Per-project detail page. |
src/components/, src/scripts/filter.js |
Entry rows, filter bar, and the vanilla-JS filtering. |
.github/workflows/ |
CI, deploy to GitHub Pages, optional ingestion. |
- Astro static site, typed content collections, zero client framework. Filtering and search are plain DOM over the server-rendered list, so the gallery still works with JavaScript disabled (the filter bar is hidden then).
- Accessible by default: semantic HTML, labelled and keyboard-navigable filters, visible focus, WCAG-AA contrast, and colourblind-safe (Okabe-Ito) category colours that are always paired with text. CI runs axe (WCAG 2.2 AA) on every built page in light and dark mode.
- Fonts are self-hosted (
@fontsource), so fonts make no third-party requests. Optional browser telemetry sends data to the configured ingestion proxy. - Images are lazy-loaded.
.github/workflows/deploy.yml builds and
publishes to GitHub Pages on every push to main.
Before the first deploy:
- Set the URL in
astro.config.mjs. Project site (https://<org>.github.io/<repo>): setsiteandbase: '/<repo>/'. User/org site or custom domain: setbase: '/'. - In repository settings, set Pages → Build and deployment → Source to GitHub Actions.
For Cloudflare Pages instead: build command pnpm run build, output directory
dist/. No Cloudflare config is included here.
Browser telemetry stays disabled until PUBLIC_RUM_ENDPOINT names an approved
HTTPS ingestion proxy. See the rollout and verification steps.
Hand-authored entries are the primary path. As an optional supplement, a separate script can surface repositories automatically:
pnpm run ingest # write new drafts
node scripts/fetch-github-projects.mjs --dry-run # preview without writingscripts/fetch-github-projects.mjs fetches
public repositories in the CMLPlatform org that carry the cml-showcase
topic and writes one draft entry per repo, derived from its description,
homepage, topics, licence, and README excerpt. When the repo has a
CITATION.cff (or else a codemeta.json), its authors and DOI fill the
draft's authors and doi.
Safeguards:
- Every generated entry gets
draft: true, so it is excluded from the built site until a maintainer reviews it, fills in the TODO fields (department, andauthorswhen no citation file named them), and removes the flag. Each draft is checked against the site's schema before it is written, and the schema refuses an entry that still has aTODOauthor, name, summary or tag oncedraft: trueis gone. - Nothing is drafted twice or overwritten: a repo is skipped when an
existing entry already links to it in
links.repo(whatever the file is called), when<repo-name>.mdor.mdxalready exists, or when it is listed inscripts/ingest-skip.txt. Add a repo there to decline it for good; closing its draft PR alone does not stop the next run.
.github/workflows/ingest.yml runs this weekly
(and on demand), runs astro check on the drafts, and opens a pull request
with any new ones, so review happens through the same PR flow as everything
else. That PR is opened with the workflow's own token, so CI does not run on it
by itself. main requires the CI check to pass, so close and reopen the PR
(or push a commit to its branch) to start CI before merging. Delete that
workflow for hand-curation only.
This prototype is meant to start a conversation about shared research infrastructure at CML. It overlaps with an AI4IE web-apps showcase, which could later reuse the same template-and-PR ingestion approach.
MIT.
