- Step 8 of 8{{[":", operatingSystem ] | join(" ") if operatingSystem }} + Step 8 of 8{{[":", installEnvironment ] | join(" ") if installEnvironment }} Check it works
diff --git a/app/views/install/codespace.html b/app/views/install/codespace.html new file mode 100644 index 00000000..19690a2a --- /dev/null +++ b/app/views/install/codespace.html @@ -0,0 +1,41 @@ +{% set installEnvironment = "Codespaces" %} +{% set steps_total = "2" %} + +{% extends 'layout.html' %} + +{% block beforeContent %} + {{ breadcrumb({ + items: [ + { + href: "/", + text: "Home" + }, + { + href: "/install/", + text: "Get started" + } + ], + href: "/install/codespaces/", + text: "Install and use the kit with your web browser" + }) }} +{% endblock %} + +{% block content %} ++ Step + {{ current_step }} + of + {{ steps_total }}{{[":", installEnvironment ] | join(" ") if installEnvironment }} + {% block stepHeader %}{% endblock %} +
+ + {% block page_content %}{% endblock %} + + {% block pagination %}{% endblock %} + +To use the kit within a Codespace you will first need to create one.
+ +1. Go to the prototype repository
+ +Go to the GitHub repository for the prototype you wish to use. For this guide we will be using the + NHS prototype kit repository. +
+ +If you do not have a prototype repository
+ +It is not possible right now to install the kit in a new Github repository unless you can install software on your computer.
+ +You can try using Codespaces with the NHS prototype kit repository. You will not be able to save your progress.
+ +2. Create a new Codespace
+ +On every Github repository page is a 'Code' button which is used to get a copy of or to use the code held within the git repository.
+ +Locate the button, click it, a dialogue box will open, at the top of the dialogue click the 'Codespaces' tab.
+Next click on the 'Create codespace on main' button. Which will open your new codespace in a new browser tab or window.
+ +
The 'Create codespace on main' button will either be shown as a large button or a small plus symbol after the label 'your workspaces in the cloud'.
+ +3. Wait for the Codespace setup to finish
+ +The Codespace will open in a new tab (or window) and begin the setup process.
+ +You will see an interface building with a progress message showing that the space (known as a 'container') is being created or rebuilt.
+ +This can take between 30 seconds and 5 minutes.
+ +4. Check that it has worked
+ +Once the Codespace has been created, you will then see the 'terminal' tab with commands being exectuted to start the prototype kit.
+When the prototype has started it will open a preview window displaying the homepage of the prototype.
+ + +
You now have a copy of the NHS prototype kit installed and running within a new GitHub Codespace.
+ +This means you can create and edit prototypes entirely in your browser.
+ +{% endblock %} + +{% block pagination %} + {{ pagination({ + "previousUrl": "/install/codespaces/index", + "previousPage": "Get started", + "nextUrl": "/install/codespaces/working-with-codespaces", + "nextPage": "Step 2: Working with Codespaces" + }) }} +{% endblock %} diff --git a/app/views/install/codespaces/index.html b/app/views/install/codespaces/index.html new file mode 100644 index 00000000..4d008eb7 --- /dev/null +++ b/app/views/install/codespaces/index.html @@ -0,0 +1,65 @@ +{% extends 'layout.html' %} + +{% block pageTitle %} + Install and use the kit with your web browser - NHS prototype kit +{% endblock %} + +{% block beforeContent %} + {{ breadcrumb({ + items: [ + { + href: "/", + text: "Home" + }, + { + href: "/install/", + text: "Get started" + } + ] + }) }} +{% endblock %} + +{% block content %} +Install and use the kit with your web browser
+ +If you cannot install the kit on your computer (for example, because you are not allowed to install Node.js) you can use an online service to edit and run code using your web browser.
+ +Services that you can use include:
+ +
-
+
- + GitHub Codespaces – free for around 60 hours per month + +
- + Gitpod – free for around 50 hours per month + +
For this guide we are using GitHub Codespaces.
+ +Before you begin
+ +You do not need any technical knowledge to use this guide.
+ +You will need a + GitHub account. +
+ +We will show you how to:
+-
+
- set up the Codespace + +
- work with the Codespace +
+ Installation usually takes up to 5 minutes. +
+ + {{ actionLink({ text: "Start guide for using the kit in a web browser", href: "/install/codespaces/create-a-codespace", classes: "nhsuk-u-margin-top-x nhsuk-heading-l" }) }} + +If you are using the browser to edit the kit, you need to manage changes in Codespaces.
+ +Save changes
+ +Changes you make are not shared with anybody else until you commit them to Git and push them to the repository.
+ +You can use the Codespace code editor and user interface to manage changes with GitHub. You can use the + quickstart guide for working with Codespaces +
+ +Manage prototypes
+ +When a Codespace is deleted, you will lose any changes you have not commited and pushed to a repository.
+GitHub Codespaces are automatically deleted after they have been stopped and have remained inactive for a defined number of days, default is 30 days.
+ + + +Publish prototypes online
+ +Codespaces are temporary and do not usually have passwords. Do not use them to publish your prototypes online.
+ +Get going
+ ++ Build a basic prototype + or + view other guides.
+ +{% endblock %} + +{% block pagination %} + {{ pagination({ + "previousUrl": "/install/codespaces/create-a-codespace", + "previousPage": "Step 1: Create a Codespace" + }) }} +{% endblock %} diff --git a/app/views/install/download.html b/app/views/install/download.html index ef044a88..e8e0af85 100644 --- a/app/views/install/download.html +++ b/app/views/install/download.html @@ -28,7 +28,7 @@- Step 4 of 8{{[":", operatingSystem ] | join(" ") if operatingSystem }} + Step 4 of 8{{[":", installEnvironment ] | join(" ") if installEnvironment }} Download and decide where to keep your prototypes
diff --git a/app/views/install/index.html b/app/views/install/index.html index dae30b7e..6c605a68 100755 --- a/app/views/install/index.html +++ b/app/views/install/index.html @@ -1,39 +1,61 @@ -{% extends 'layout.html' %} {% block pageTitle %} Get started - NHS prototype -kit {% endblock %} {% block beforeContent %} {{ breadcrumb({ href: "/", text: -"Home" }) }} {% endblock %} {% block content %} -Get started
+{% extends 'layout.html' %} -To use the kit you'll need some basic knowledge of HTML, for example what tags and attributes are and how to copy and paste code.
+{% block pageTitle %} + Get started - NHS prototype kit +{% endblock %} + +{% block beforeContent %} + {{ breadcrumb({ href: "/", text: "Home" }) }} +{% endblock %} + +{% block content %} +Get started
+ +To use the kit you'll need some basic knowledge of HTML, for example what tags and attributes are and how to copy and paste code.
-You can learn basic HTML and CSS at mdn, codecademy or other online tutorials.
+You can learn basic HTML and CSS at + mdn, + codecademy + or other online tutorials.
-You'll also need to install some other tools and software.
+You'll also need to install some other tools and software.
-Choose from the:
+Choose from the:
--
-
- - install guide – for those new to - prototyping in code - -
- - advanced install guide – for those - familiar with prototyping in code - -
-
+
- + install guide + – for those new to prototyping in code + +
- + advanced install guide + – for those familiar with prototyping in code + +
NHS England Windows laptops
+NHS England Windows laptops
-See the guide for setting up the kit on NHS England Windows laptops.
+See the + guide for setting up the kit on NHS England Windows laptops.
-Updating
+If you cannot install software
-If you have already got an NHS prototype but need to upgrade it to the latest version, see the guide to updating the kit.
+If you want to use the kit but cannot install it onto your computer, see the + guide to install and use the kit with your web browser +
-Switching from the GOV.UK Prototype Kit
-If you are new to the NHS prototype kit but are familiar with the GOV.UK Prototype Kit, you can find out how the NHS prototype kit is different from the GOV.UK Prototype Kit.
++ +
Updating
+ +If you have already got an NHS prototype but need to upgrade it to the latest version, see the + guide to updating the kit.
+ +Switching from the GOV.UK Prototype Kit
+If you are new to the NHS prototype kit but are familiar with the GOV.UK Prototype Kit, you can find out + how the NHS prototype kit is different from the GOV.UK Prototype Kit.
+