Skip to content

nptscot/scheme-sketcher

Repository files navigation

NPT Scheme Sketcher

This is an active travel scheme sketcher specialized for the Scotland Network Planning Tool.

Developer docs

This is a Svelte app using TypeScript. To run locally, you'll need npm. Clone the repo, then npm i to install dependencies, and npm run setup-govuk to do some one-time style setup. After that, npm run dev to start a local dev server that auto-reloads with code changes.

The main branch automatically deploys to GH Pages at https://nptscot.github.io/scheme-sketcher for every commit. To share experiments easily, git branches deploy to https://nptscot.github.io/scheme-sketcher/BRANCH_NAME.

Major dependencies include scheme-sketcher-lib, route-snapper, and the GOV.UK design system.

The app also depends on route snapper files generated by the data-prep/build_route_snappers.sh script. The script is small; directly read it to understand how it works.