Skip to content

Commit

Permalink
Add instructions for installation on NHS England machines (#68)
Browse files Browse the repository at this point in the history
Adds specific instructions for users of NHS England managed Windows
laptops, given that these are a core user group.

Based on the content from the [internal
guide](https://nhs.sharepoint.com/sites/X26_URPG/SitePages/nhs-prototype-kit.aspx).

Fixes #8.

Not quite sure how best to link this in with the existing installation
instructions for Windows and general guide. Have added a link from the
Get started page for now but open to better ideas!

➡️ Preview here:
https://nhs-prototyp-add-nhs-en-stqwjl.herokuapp.com/install/nhs-england-windows-laptops

---------

Co-authored-by: vickytnz <[email protected]>
  • Loading branch information
frankieroberto and vickytnz authored Nov 4, 2024
1 parent a141bcd commit b8c8f7b
Show file tree
Hide file tree
Showing 6 changed files with 126 additions and 18 deletions.
2 changes: 2 additions & 0 deletions app/views/how-tos/switching-from-govuk-prototype-kit.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ <h2 class="nhsuk-heading-m">
Installing and running the NHS.UK prototype kit
</h2>

{% include "install/_nhs-england-laptop-warning.html" %}

<p>When you are installing and running your prototype:</p>

{{ list({ title: "Do", type: "tick", items: [ { item: '<a
Expand Down
4 changes: 4 additions & 0 deletions app/views/install/_nhs-england-laptop-warning.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{{ insetText({
html: '<p>There are some <a href="/install/nhs-england-windows-laptops">extra steps for NHS England Windows laptops</a> you must do before you start.</p>',
classes: "nhsuk-u-padding-top-3 nhsuk-u-padding-bottom-3 nhsuk-u-margin-bottom-4"
}) }}
9 changes: 8 additions & 1 deletion app/views/install/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ <h1>Advanced install guide</h1>

<p>The kit is built on the <a href="http://expressjs.com/" rel="noopener">Express</a> framework, and uses <a href="https://github.com/nhsuk/nhsuk-frontend" rel="noopener">NHS.UK frontend</a>.</p>



<h2>Requirements</h2>

<p><a href="https://nodejs.org">Node.js</a> version 20 or higher</p>
<p><a href="https://nodejs.org">Node.js</a> version 20 or higher.</p>

{% include "install/_nhs-england-laptop-warning.html" %}

<h2>Download the kit</h2>

Expand All @@ -39,6 +43,9 @@ <h2>Download the kit</h2>

<h2>Install dependencies</h2>




<pre class="app-pre"><code class="app-code">npm install</code></pre>

<h2 class="nhsuk-u-margin-top-7">Run the kit</h2>
Expand Down
4 changes: 4 additions & 0 deletions app/views/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ <h1 class="nhsuk-heading-xl">Get started</h1>
</li>
</ul>

<h2 class="nhsuk-heading-m">NHS England Windows laptops</h2>

<p>See <a href="/install/nhs-england-windows-laptops">guide for setting up the kit on NHS England Windows laptops</a>.</p>

<h2 class="nhsuk-heading-m">Updating</h2>

<p>
Expand Down
73 changes: 73 additions & 0 deletions app/views/install/nhs-england-windows-laptops.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{% extends 'layout.html' %}

{% block pageTitle %}
Set up the prototype kit on an NHS England Windows laptop - NHS.UK prototype kit
{% endblock %}

{% block beforeContent %}
{{ breadcrumb({
items: [
{
href: "/",
text: "Home"
}
],
href: "/install",
text: "Get started"
}) }}
{% endblock %}



{% block content %}
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-column-two-thirds">

<h1 class="nhsuk-heading-l">Set up the prototype kit on an NHS England Windows laptop</h1>

<p>If you have a Windows laptop issued by NHS England corporate IT, before you start any of the install guides you will need to:</p>

<ol>
<li>create a local folder in the right place for your code to work.</li>
<li>install the software that you need.</li>
</ol>


<h2 class="nhsuk-heading-m">1. Create a local folder for your prototypes</h2>

<p>Within the root of your OneDrive create a new folder named <code><strong>DevWspace</strong></code>.</p>

<p>This folder name was added to an approved list to allow the creation of virtual environments and allow scripts to be executed.</p>

<p>The path should look like this after you have created it:</p>

<pre class="app-pre"><code class="app-code">"C:\Users\%username%\OneDrive - NHS\DevWspace"</code></pre>

<p>Use this folder:</p>
<ul>
<li>for any prototypes that you make</li>
<li>path for any software for your kit that asks for a ‘path’ - ask a developer on your team if you need help</li>
</ul>


<h2 class="nhsuk-heading-m">2. Install the software you need to use the kit</h2>

<p>Go to the Company Portal application to install this software:</p>

<ul>
<li>Terminal</li>
<li>Visual Studio Code</li>
<li>Node.js and NPM</li>
<li>Git for Windows</li>
<li>Github Desktop</li>
</ul>

<p>You may need to restart your computer to finish installing the software.</p>

<h2 class="nhsuk-heading-m">What to do next</h2>

<p>After you have finished these steps you can continue to the <a href="/install/simple">install guide</a> or the <a href="/install/advanced">advanced install guide</a>.</p>

</div>
</div>
{% endblock %}
52 changes: 35 additions & 17 deletions app/views/install/simple.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,49 @@
{% endblock %}

{% block content %}
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-row">
<div class="nhsuk-grid-column-two-thirds">
<h1>Install guide</h1>

<div class="nhsuk-grid-column-two-thirds">
<p class="nhsuk-lede-text">
To start making prototypes you need to setup the right tools to make the
kit work.
</p>

<h1>
Install guide
</h1>
<p>This guide will show you how to get setup in 8 steps.</p>

<p class="nhsuk-lede-text">To start making prototypes you need to setup the right tools to make the kit work.</p>
<p>You don’t need any technical knowledge to follow along.</p>

<p>This guide will show you how to get setup in 8 steps.</p>
<p>
Installation takes up to 20 minutes depending on how much you need to
install.
</p>

<p>You don’t need any technical knowledge to follow along.</p>
{% include "install/_nhs-england-laptop-warning.html" %}

<p>Installation takes up to 20 minutes depending on how much you need to install.</p>
{{ actionLink({ text: "Start install guide", href: "/install/mac-or-windows" }) }}

<p>If you have any problems, ask a developer on your team (if you have one), <a href="mailto:[email protected]?subject=NHS.UK prototype kit - Installation">email us</a> or get in touch on the <a href="https://nhs-service-manual.slack.com/messages/CFYL2GDGW" rel="nofollow">NHS digital service manual #prototype-kit Slack channel</a>.</p>
<h2 class="nhsuk-heading-m">Problems using this guide</h2>
<p>
If you have any problems, ask a developer on your team (if you have one),
<a
href="mailto:[email protected]?subject=NHS.UK prototype kit - Installation"
>email us</a
>
or get in touch on the
<a
href="https://nhs-service-manual.slack.com/messages/CFYL2GDGW"
rel="nofollow"
>NHS digital service manual #prototype-kit Slack channel</a
>.
</p>

<div class="nhsuk-inset-text">
<p>If you are familiar with using git and the terminal, then you might prefer the <a href="/install/advanced">advanced guide</a>.</p>
</div>

<a class="nhsuk-button" href="/install/mac-or-windows">Start now</a>

</div>
<h2 class="nhsuk-heading-m">Other install guides</h2>

<p>
If you are familiar with using git and the terminal, then you might prefer
the <a href="/install/advanced">advanced guide</a>.
</p>
</div>
</div>
{% endblock %}

0 comments on commit b8c8f7b

Please sign in to comment.