57 lines (39 loc) · 1.31 KB

Prototype NCRS Structured

prototype-ncrs-structured is the source repository for NCRS prototype content consumed by ncrs-prototype-agentic.

Purpose

This repo is where NCRS prototype structure and content are authored. A host repo can pull from here and run immediately.

Source layout supported today

Current sync uses the root app/ layout:

app/views/
app/assets/
app/data/
app/routes.js
optional app/config.js, app/filters.js, app/locals.js
optional instructions/
optional docs/
optional manifest.json

exports/ is optional for later. Not required right now.

Local development

npm install
npm start

Consumer integration (`ncrs-prototype-agentic`)

From ncrs-prototype-agentic:

npm run sync:structured

Or explicit source/ref:

./scripts/sync-prototype-ncrs-structured.sh git@github.com:NHSDigital/prototype-ncrs-structured.git <ref>

Workflow recommendation

Make and commit changes in this repo.
Push to main (or tag a release for stable handoff).
In consumer repo, run sync.
Run npm start and smoke test routes.

Notes

Keep paths stable to avoid downstream breakage.
Prefer additive changes; document breaking changes in CHANGELOG.md.
Use tags/releases when you need reproducible integration points.