Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guidance for anyone switching to the NHS prototype kit from the GOV.UK prototype kit #6

Closed
vickytnz opened this issue Oct 15, 2024 · 3 comments · Fixed by #26
Closed

Comments

@vickytnz
Copy link
Contributor

Suggestion

What is the suggestion?

The NHS prototype kit is similar to buy different from the GOV.UK prototype kit. Some basic differences would help manage expectations for people switching.

What steps are required to do this suggestion?

Noting any key differences:

  • the install being different npm run watch compared to npm run dev
  • that it may be missing some functionality
  • that is may be on an older version of node (and maybe needing a node version manager to switch)
@frankieroberto frankieroberto transferred this issue from nhsuk/nhsuk-prototype-kit Oct 16, 2024
@frankieroberto
Copy link
Contributor

@vickytnz nice idea! I took some notes when moving across too on what the differences are. I can dig those out.

@vickytnz
Copy link
Contributor Author

vickytnz commented Oct 21, 2024

First pass with more comments. A few principles I have used for this:

  • always start with the NHS.UK version first to keep things simple and consistent
  • try to keep things generic enough that it's easy to change - for example not naming the different versions of node
  • try to use NHS.UK prototype kit when needed but otherwise just

Switching from the GOV.UK prototype kit

If you have used the GOV.UK prototype kit before, most of the things you know are the same in the NHS.UK prototype kit, but there are some differences.

Installing and running the kit

When you are installing and running your prototype kit you need to:

  • check if you have the right version of node - if you need to use both the NHS.UK and GOV.UK prototype kit at the same time you may need to switch node versions for example by installing a node version manager
  • run your prototype with the action npm run watch and not npm run dev

Making pages

When you are making your pages you need to:

@vickytnz vickytnz linked a pull request Oct 21, 2024 that will close this issue
2 tasks
@vickytnz
Copy link
Contributor Author

Updated dos and don't version is here #26 (comment)

vickytnz added a commit that referenced this issue Oct 26, 2024
## Description

Version of #6 

### How to page 
![how-to page with 'advanced usage - switching from the govuk prototype
kit](https://github.com/user-attachments/assets/0eeca9ed-e436-403a-bfbd-b1fb98adea6f)

### Switching page
![switching from the govuk prototype kit
page](https://github.com/user-attachments/assets/d8a44c6b-2ae3-495e-834c-6ba7750c93ea)




## Checklist

- [ ] Tested against our [testing
policy](https://github.com/nhsuk/nhsuk-frontend/blob/master/docs/contributing/testing.md)
(Resolution, Browser & Accessibility)
- [ ] CHANGELOG entry

---------

Co-authored-by: Frankie Roberto <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants