Release 1.0.1

CHANGELOG.md

@@ -0,0 +1,19 @@
+# NHS.UK prototype kit Changelog
+
+## 1.0.1 - Feb 21, 2019
+
+:new: **New features**
+
+-  [Installation guides update for Windows and Mac following testing with users](https://github.com/nhsuk/nhsuk-prototype-kit/pull/68)
+- The prototype kit now is properly versioned and is the version is indicated in `package.json` `version` field and also on the index page of the docs.
+
+:wrench: **Fixes**
+
+-  [Header and footer inconsistency on the branching examples](https://github.com/nhsuk/nhsuk-prototype-kit/issues/71)
+-  Fix inconsistencies with page titles, should be `Page name - NHS.UK prototype kit` 
+
+## 1.0.0 - Feb 5, 2019
+
+:tada: **Official release of the NHS.UK prototype kit**
+
+- v1.0.0 of the NHS.UK prototype kit!

app.js

@@ -14,6 +14,7 @@ const sessionInMemory = require('express-session')
 dotenv.config()
 
 // Local dependencies
+const packageInfo = require('./package.json');
 const authentication = require('./middleware/authentication');
 const automaticRouting = require('./middleware/auto-routing');
 const config = require('./app/config');
@@ -56,7 +57,8 @@ var nunjucksConfig = {
 
 nunjucksConfig.express = app
 
-var nunjucksAppEnv = nunjucks.configure(appViews, nunjucksConfig)
+var nunjucksAppEnv = nunjucks.configure(appViews, nunjucksConfig);
+nunjucksAppEnv.addGlobal('version', packageInfo.version);
 
 // Add Nunjucks filters
 utils.addNunjucksFilters(nunjucksAppEnv)
@@ -186,6 +188,7 @@ if (useDocumentation || onlyDocumentation == 'true') {
     autoescape: true,
     express: documentationApp
   });
+  nunjucksAppEnv.addGlobal('version', packageInfo.version);
 
   // Add Nunjucks filters
   utils.addNunjucksFilters(nunjucksAppEnv)

app/assets/sass/main.scss

@@ -8,4 +8,6 @@
 @import 'components/panel-confirmation';
 @import 'components/related-nav';
 
-// Add your extra styles here...
+///////////////////////////////////////////
+// Add your custom CSS/Sass styles below... 
+///////////////////////////////////////////

app/views/examples/branching/answer-no.html

@@ -1,4 +1,4 @@
-{% extends "layouts/layout.html" %}
+{% extends "layouts/layout-transactional.html" %}
 
 {% set mainClasses = 'nhsuk-main-wrapper--s' %}
 

app/views/examples/branching/answer-yes.html

@@ -1,4 +1,4 @@
-{% extends "layouts/layout.html" %}
+{% extends "layouts/layout-transactional.html" %}
 
 {% set mainClasses = 'nhsuk-main-wrapper--s' %}
 

app/views/index.html

@@ -1,9 +1,15 @@
+<!-- 
+ADDING CUSTOM CSS
+Add your custom CSS/Sass to /app/assets/sass/main.scss
+-->
+
+
 <!-- Extends the layout from /app/views/layouts/layout.html -->
 {% extends 'layouts/layout.html' %}
 
 <!-- Set the page title inside this block -->
 {% block pageTitle %}
-  Prototype kit
+  NHS.UK prototype kit
 {% endblock %}
 
 <!-- Breadcrumb goes inside this block -->
@@ -14,13 +20,13 @@
   <div class="nhsuk-grid-row">
     <div class="nhsuk-grid-column-two-thirds">
 
-      <!-- Page title goes here -->
+      <!-- Change the page title here -->
       <h1>
         NHS.UK prototype kit
+        <span class="nhsuk-caption-xl nhsuk-caption--bottom">Version {{version}}</span>
       </h1>
-      <!-- End of page title -->
 
-      <!-- Content goes here -->
+      <!-- Add your content here -->
 
       <p class="nhsuk-body-l">This kit lets you rapidly create HTML prototypes of NHS services.</p>
 
@@ -33,7 +39,7 @@ <h2 class="nhsuk-heading-m">About this page</h2>
       <h2 class="nhsuk-heading-m">Examples and documentation</h2>
 
       <ul>
-        <li><a href="/docs">Example pages and documentation</a></li>
+        <li><a href="/docs/how-tos">Example pages and documentation</a></li>
         <li><a href="https://beta.nhs.uk/service-manual/styles-components-patterns">NHS digital service manual</a>
         </li>
       </ul>

app/views/layouts/layout-nhsuk.html

@@ -5,7 +5,7 @@
 
 <!-- Set the page title inside this block -->
 {% block pageTitle %}
-  NHS.UK prototype kit - NHS.UK page layout
+  NHS.UK page layout - NHS.UK prototype kit
 {% endblock %}
 
 <!-- Header goes inside this block -->

app/views/templates/blank-nhsuk.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-nhsuk.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Blank template
+  Blank template - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}

app/views/templates/blank-transactional.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-transactional.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Blank transactional template
+  Blank transactional template - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}

app/views/templates/check-your-answers.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-transactional.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Check your answers template
+  Check your answers template - NHS.UK prototype kit
 {% endblock %}
 
 {% block content %}

app/views/templates/confirmation-page.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-transactional.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Confirmation page template
+  Confirmation page template - NHS.UK prototype kit
 {% endblock %}
 
 {% block content %}

app/views/templates/content-page.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-nhsuk.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype Kit - Content page template
+  Content page template - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}

app/views/templates/start-page.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout-nhsuk.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Start page template
+  Start page template - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}

docs/documentation_routes.js

@@ -7,14 +7,27 @@ router.get('/', function(req , res){
   res.render('index');
 });
 
+// Install routing
+router.post('/install', function (req, res) {
+  let install = req.body.install;
+
+  if (install === 'Simple') {
+    res.redirect('/docs/install/simple')
+  } if (install === 'Developer') {
+    res.redirect('/docs/install/advanced')
+  } else {
+    res.redirect('/docs/install/download-zip')
+  }
+});
+
 // Mac or Windows install
 router.post('/install/mac', function (req, res) {
   let machine = req.body.machine;
 
   if (machine === 'Mac') {
-    res.redirect('/docs/install/mac/requirements')
+    res.redirect('/docs/install/mac/terminal')
   } else {
-    res.redirect('/docs/install/windows/requirements')
+    res.redirect('/docs/install/windows/terminal')
   }
 });
 

docs/views/about.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - About
+  About - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}

docs/views/install/advanced.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Advanced install
+  Developer friendly install guide - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}
@@ -22,7 +22,7 @@
 
     <div class="nhsuk-grid-column-two-thirds">
 
-      <h1>Advanced install guide</h1>
+      <h1>Developer friendly install guide</h1>
 
       <p class="nhsuk-body-l">The prototype kit is built on the <a href="http://expressjs.com/" target="_blank">Express<span class="nhsuk-u-visually-hidden">opens in new window</span></a></a> framework, and uses the <a href="https://github.com/nhsuk/nhsuk-frontend" target="_blank">NHS.UK frontend<span class="nhsuk-u-visually-hidden">opens in new window</span></a>.</p>
 

docs/views/install/check-it-works.html

@@ -1,7 +1,7 @@
 {% extends 'layouts/layout.html' %}
 
 {% block pageTitle %}
-  NHS.UK prototype kit - Check it works
+  Check it works - NHS.UK prototype kit
 {% endblock %}
 
 {% block beforeContent %}
@@ -23,38 +23,45 @@
     <div class="nhsuk-grid-column-two-thirds">
 
       <h1>
-        <span class="nhsuk-caption-l">Step 10 of 10</span>
+        <span class="nhsuk-caption-l">Step 8 of 8</span>
         Check it works
       </h1>
+
+      <h2 class="nhsuk-u-visually-hidden">Check your local host</h2>
 
       <p class="nhsuk-body-l">In your web browser, visit <a href="http://localhost:3000" target="_blank">http://localhost:3000 <span class="nhsuk-u-visually-hidden">opens in a new tab</span></a></p>
 
       <p>You should see the prototype welcome page.</p>
 
       <img class="app-img-guide nhsuk-u-margin-bottom-0" alt="Screenshot of the prototype kit welcome page" src="/images/prototype-kit-landing-page.png" />
 
-      <h2>Quitting the kit</h2>
+      <details class="nhsuk-details nhsuk-expander nhsuk-u-margin-bottom-7">
+        <summary class="nhsuk-details__summary">
+          <span class="nhsuk-details__summary-text">
+          I don't see that page
+          </span>
+        </summary>
+        <div class="nhsuk-details__text">
+          <h3>If you don't see that page</h3>
 
-      <p>Sometimes you need to stop the kit running to use things like Git or Heroku. You can learn about Git and Heroku in the <a href="/docs/how-tos/">How to guides</a>.</p>
-
-      <p>It’s okay to leave the kit running for days or while your computer is asleep.</p>
+          {% block branchingContent %}
+          {% endblock %}
 
-      <h3>To quit the kit</h3>
+          <img class="app-img-guide nhsuk-u-margin-bottom-0" alt="Screenshot of the terminal running the kit" src="/images/mac/terminal-npm-run-3000.png" />
 
-      {% block branchingContent %}
-      {% endblock %}
+          <p>Make sure the number in the terminal matches the one in the web address.</p>
+
+          <p>The kit automatically changes to <strong>http://localhost:3001</strong> if <strong>http://localhost:3000</strong> is already in use.</p>
+        </div>
+      </details>
 
       <h2>Installation complete</h2>
 
       <p>The kit is now installed. Congratulations!</p>
 
-      <div class="nhsuk-panel">
-
-        <h2>Get started</h2>
-
-        <p><a href="/docs/how-tos/making-pages">Start making pages</a></p>
+      <h2>Getting going</h2>
 
-      </div>
+      <p><a href="/docs/how-tos/making-pages">Start making pages</a></p>
 
       {% block pagination %}
       {% endblock %}

docs/views/install/download-zip.html

@@ -0,0 +1,47 @@
+{% extends 'layouts/layout.html' %}
+
+{% block pageTitle %}
+  NHS.UK prototype kit - Download the kit
+{% endblock %}
+
+{% block beforeContent %}
+  {{ breadcrumb({
+    items: [
+      {
+        href: "/docs",
+        text: "Home"
+      }
+    ],
+    href: "/docs/install",
+    text: "Install"
+  }) }}
+{% endblock %}
+
+{% block content %}
+  <div class="nhsuk-grid-row">
+
+    <div class="nhsuk-grid-column-two-thirds">
+
+      <h1>
+        Download the kit
+      </h1>
+
+      <h2>Zip file</h2>
+
+      <p>The simplest way to get the kit is to <a href="https://github.com/nhsuk/nhsuk-prototype-kit/archive/master.zip" data-link="download">download it as a zip</a>.</p>
+
+      <h2>GitHub</h2>
+
+      <p>You can also clone or download a copy from <a href="https://github.com/nhsuk/nhsuk-prototype-kit">GitHub</a></p>
+
+      {{ backLink({
+        "href": "/docs/install",
+        "text": "Back to Installing the kit",
+        "classes": "nhsuk-u-margin-top-6"
+      }) }}
+
+
+    </div>
+
+  </div>
+{% endblock %}