https://github.com/nhsdigital/prototype-nhs-ssr
https://github.com/nhsdigital/prototype-nhs-ssr
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nhsdigital/prototype-nhs-ssr
- Owner: NHSDigital
- License: mit
- Created: 2024-05-17T13:10:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T16:15:57.000Z (over 1 year ago)
- Last Synced: 2024-05-29T06:16:17.076Z (over 1 year ago)
- Language: HTML
- Size: 73.3 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NHS.UK prototype kit
Visit the NHS.UK prototype kit site to download the latest version and read the documentation.
## About the NHS.UK prototype kit
The 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.
## Security
If you publish your prototypes online, they must be protected by a username and password. This is to prevent members of the public finding prototypes and thinking they are real services.
You 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.
## Installation instructions
- Install guide (non technical)
- Developer friendly install guide (technical)
### Testing
There is currently no automated testing included with this product.
## Contribute
If you want to contribute to the NHS.UK prototype kit, by reporting bugs, fixing bugs, suggesting new features or writing documentation, then read our [contributing guidelines](CONTRIBUTING.md).
## Development environment
[](https://gitpod.io/#https://github.com/nhsuk/nhsuk-prototype-kit)
## Versioning and deploying the prototype kit
> The below is only for maintainers of the prototype kit source code - these instructions aren't relevant if you're building your own protoype using the kit.
- Merge required changes via PR into `main` branch
- Ensure the version number in `package.json` and `CHANGELOG.md` match, with a summary of the changes included in the changelog
- Pull down merged `main` branch to your local repository
- Create a tag with the version number from the latest commit on `main`
- If the latest version you're looking to push is version "1.2.3", you can do this on the command line with
- `git tag v1.2.3`
- `git push --tags`
- [Github actions](https://github.com/nhsuk/nhsuk-prototype-kit/actions/workflows/release.yml) will spring to life and create a release which will be visible on the [releases tab](https://github.com/nhsuk/nhsuk-prototype-kit/releases) of the repository.
- Finally, edit the description of the release to match the content entered into the changelog.
## Support
The NHS.UK prototype kit is maintained by NHS Digital. [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).