A place for us to document our service designs for the GOV.UK Teaching Vacancies service.

https://tv-design-history.herokuapp.com/

Clone this project using Git. New to Git? Here is more information about cloning a repository.

Use Terminal to navigate to the directory and run npm install.

If the install is successful, run npm start. If there are erros, follow the prompts to debug then.

Follow the prompts in Terminal to open the design history in your browser. If the set up is successful it will be available at http://localhost:8080/.

Start with the google docs template.

Get your entry reviewed by your peers.

Duplicate an existing entry. You will find them in the /posts directory.

Give the .md file a unique name and date it to reflect when the work was done.

Once you have finished adding the content of the post, check it looks ok in your browser at http://localhost:8080/.

Raise a pull request. Here is more information about pull requests.

Get the pull request reviewed by a peer.

Once the pull request is approved, merge it.

GOV.UK PaaS will then take over and the entry will be live shortly.

Take decent screen captures of your work.

Optimise the image file sizes using TinyPNG.

Create a directory for the images in /images.

The directory name needs to match your post name (besides the date).

Use the image macro to include an image in your post.

With caption:

{{ appFigure({
  image: {
    file: "file-name.png",
    alt: "A description of the image"
  },
  caption: "An optional caption"
}) }}

Without caption:

{{ appFigure({
  image: {
    file: "file-name.png",
    alt: "A description of the image"
  }
}) }}

A friendly developer will be able to support you when troubleshooting most issues.

You can also reach out to other interaction designers across the DfE. Many are also using this tool.

The design history uses the GOV.UK Design System and the Eleventy static site generator.

It is deployed to GOV.UK PaaS using Github Actions.