{"id":18952270,"url":"https://github.com/nhsuk/nhsuk-prototype-kit","last_synced_at":"2025-04-16T01:33:30.682Z","repository":{"id":24050272,"uuid":"162266935","full_name":"nhsuk/nhsuk-prototype-kit","owner":"nhsuk","description":"NHS.UK prototype kit enables you to make interactive prototypes that will look like pages on NHS.UK. The prototypes you make are a great way to show ideas to others and for conducting user research.","archived":false,"fork":false,"pushed_at":"2024-03-26T11:47:26.000Z","size":17363,"stargazers_count":46,"open_issues_count":14,"forks_count":33,"subscribers_count":19,"default_branch":"main","last_synced_at":"2024-03-27T11:32:41.197Z","etag":null,"topics":["nhs","nhsuk","prototype-kit"],"latest_commit_sha":null,"homepage":"http://nhsuk-prototype-kit.azurewebsites.net/docs","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nhsuk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-12-18T09:55:16.000Z","updated_at":"2024-04-23T12:17:26.862Z","dependencies_parsed_at":"2023-02-14T20:31:31.831Z","dependency_job_id":"522f1576-d34f-44c1-8d7e-7a345f670dae","html_url":"https://github.com/nhsuk/nhsuk-prototype-kit","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhsuk%2Fnhsuk-prototype-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhsuk%2Fnhsuk-prototype-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhsuk%2Fnhsuk-prototype-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhsuk%2Fnhsuk-prototype-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nhsuk","download_url":"https://codeload.github.com/nhsuk/nhsuk-prototype-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249182524,"owners_count":21226082,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nhs","nhsuk","prototype-kit"],"created_at":"2024-11-08T13:32:27.074Z","updated_at":"2025-04-16T01:33:30.670Z","avatar_url":"https://github.com/nhsuk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NHS prototype kit\n\nVisit the \u003ca href=\"https://prototype-kit.service-manual.nhs.uk\"\u003eNHS prototype kit site\u003c/a\u003e to download the latest version and read the documentation.\n\n## About the NHS prototype kit\n\nThe NHS prototype kit enables you to make interactive prototypes that will look like pages on NHS.UK. The prototypes you make are a great way to show ideas to others and for conducting user research.\n\n## Security\n\nIf you publish your prototypes online, they must be protected by a \u003ca href=\"https://prototype-kit.service-manual.nhs.uk/how-tos/publish-your-prototype-online\"\u003eusername and password\u003c/a\u003e. This is to prevent members of the public finding prototypes and thinking they are real services.\n\nYou must protect user privacy at all times, even when using prototypes. Prototypes made with the kit look like NHS.UK, but do not have the same security provisions. Always make sure you are handling user data appropriately.\n\n## Installation instructions\n\n- \u003ca href=\"https://prototype-kit.service-manual.nhs.uk/install/simple\"\u003eInstall guide (non technical)\u003c/a\u003e\n- \u003ca href=\"https://prototype-kit.service-manual.nhs.uk/install/advanced\"\u003eDeveloper friendly install guide (technical)\u003c/a\u003e\n\n### Running the kit\n\nStart the kit with `npm run watch`.\n\n## Contribute\n\nIf you want to contribute to the NHS prototype kit, by reporting bugs, fixing bugs, suggesting new features or writing documentation, then read our [contributing guidelines](CONTRIBUTING.md).\n\n## Development environment\n\nBefore running Gitpod, you must \u003ca href=\"https://github.com/apps/gitpod-io/installations/new\"\u003einstall the Gitpod.io application on your GitHub account\u003c/a\u003e.\n\nGitpod also requires access to public repositories. Enable this via \u003ca href=\"https://gitpod.io/integrations\"\u003eGitpod integrations\u003c/a\u003e. (Click on the 3 dots to edit permissions for your GitHub account. Gitpod may pre-select permissions. You need read/write access to code in the repos.)\n\nUsing your own GitHub credentials you can create, change, commit and push to branches on our Gitpod container via the \"ready to code\" button below.\n\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/nhsuk/nhsuk-prototype-kit)\n\nRead an \u003ca href=\"https://www.gitpod.io/docs\"\u003eintroduction to Gitpod (on Gitpod's website)\u003c/a\u003e.\n\n## Release lifecycle\n\n\u003e The below is only for maintainers of the prototype kit source code - these instructions aren't relevant if you're building your own prototype using the kit.\n\n### Testing\n\nRun unit tests locally with `npm run test`.\n\n### Making changes\n\n- Merge required changes via pull requests into `main` branch. As you do so, document changes in the `CHANGELOG.md` under an 'Unreleased' header at the top.\n\n### Releasing\n\n- Open a new pull request which changes the version number in `package.json` and `package-lock.json` and which updates the 'Unreleased' header in the `CHANGELOG.md` to the new version number and release date. Merge this into `main`.\n- Visit the [Create a new release page](https://github.com/nhsuk/nhsuk-prototype-kit/releases/new) on GitHub. In the 'Choose a tag' dropdown, create a new tag for the new version number, prefixed with a `v`. Use the same format for the release title. You can use the 'Generate release notes' feature to generate some initial release notes, and then edit these as needed. Make sure the \"Set as latest release\" checkbox is checked. Publish the release (or save as draft if you’re not ready).\n- Update the `prototypeKitVersion` value in [the `package.json` of the prototype kit website](https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/blob/main/package.json#L4) - this will update the 'Download' link to point to the new zip file.\n- Add some details about the new release to the [What’s new page](https://github.com/nhsuk/nhsuk.service-manual.prototype-kit.docs/blob/main/app/views/whats-new/updates.html) on the prototype kit website\n- Announce the new release on the Service Manual Slack, NHS England Slack, and any other appropriate locations\n\n### Code Analysis\n\nCode analysis results can be found in [SonarQube](https://sonar.nhswebsite.nhs.uk/dashboard?id=nhsuk-prototype-kit).\n\n## Support\n\nThe NHS prototype kit is maintained by NHS England. [Email us](mailto:service-manual@nhs.net), open a [Github issue](https://github.com/nhsuk/nhsuk-prototype-kit/issues/new) or get in touch on the [NHS digital service manual Slack workspace](https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsuk%2Fnhsuk-prototype-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsuk%2Fnhsuk-prototype-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsuk%2Fnhsuk-prototype-kit/lists"}