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

Should the prototype kit be or have a github template? #444

Open
vickytnz opened this issue Dec 14, 2024 · 1 comment
Open

Should the prototype kit be or have a github template? #444

vickytnz opened this issue Dec 14, 2024 · 1 comment
Labels
type: enhancement 💡 New feature or request

Comments

@vickytnz
Copy link
Contributor

The current NHSDigital codespace - our preferred code organisation for prototype code - has a public template for most other stuff. https://github.com/NHSDigital/repository-template

Having a template would also help a lot with the instructions for codespaces which generally offer examples as a template https://docs.github.com/en/codespaces/getting-started/quickstart

Joe Lanman's example of a codespace for the govuk prototype kit is also a template https://github.com/joelanman/govuk-prototype-kit-prototype

This could also help with the issue of people forking when they should clone?

@frankieroberto
Copy link
Contributor

I’ve considered this a bit too. It’s something we for the X-GOVUK design history project, see https://github.com/x-govuk/govuk-design-history-template

It could make sense to do this after publishing an npm package which contains most of the code for the kit. Then we’d have:

  • a repo for building and publishing the kit itself
  • the existing NHS Frontend repo and package
  • a template repo for an Express app which uses both the kit (as middleware) and NHS Frontend (css, JavaScript and nunjucks templates and macros)

That would then make prototypes far easier to update (via npm) and would let us separate out the files in the kit used for developing it (eg the tests and linter setup) from files that are useful to have within prototypes themselves.

More moving parts though! And there might be limits to what can be handled purely as Express middleware.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement 💡 New feature or request
Development

No branches or pull requests

2 participants