Early Years Recovery research prototype

Requirements

• GOV.UK Prototype Kit 13.16.2
• Node.js 20.11.0

Getting started

1. Clone the repository
2. Make sure you have the correct version of node.js installed
3. Run npm install to install dependencies
4. Run npm run dev to start the project

More detailed guidance is available on the prototype docs

File structure

To add a milestone, create a folder in app/views with the name of the milestone (e.g. 'sprint-5'), and either:

1. copy over the files needed from the previous sprint, making the changes necessary
2. inherit from the file in the previous milestone and overwrite them

Inheriting files

Many of the files inherit from previous versions, either in a previous milestone or in the 'extends' folder. These are then called, as necessary, in a later file with the following:

{% extends "../[PREVIOUS MILESTONE]/[FILE NAME]" %}

Overwriting

As the project uses Nunjucks, files can easily be inherited as above. To make changes to the inherted version:

1. Create a block in the original file:

{% block BlockName %}
  // Code to be overwritten
{% endblock %}

2. Overwrite the block in the new file:

{% block BlockName %}
  // New code
{% endblock %}

When using M1 Mac

You need to perform a workaround to use the Cloudfoundry CLI with Arm achitecture:

1. Create a Rosetta terminal: Navigate to /Applications/Utilities in Finder. Right click on Terminal, click 'Duplicate'. Rename this new terminal something helpful, e.g. 'Rosetta Terminal'. Right click on Rosetta Terminal, click 'Get Info' and check the box 'Open using Rosetta'
2. You will need to have an additional Rosetta version of Homebrew, which will be installed in the default location for an Intel chip. To do this open Rosetta Terminal and install homebrew following instructions on the homebrew website.
3. To make it easier to differentiate between the two versions of homebrew, create an alias for the one you have just installed. To do this: alias ibrew='arch -x86_64 /usr/local/Homebrew/bin/brew'
4. Verify that this has worked by typing alias. You should see it there.
5. Run ibrew install cloudfoundry/tap/cf-cli@8

Potential Issues:

Rosetta is not installed. To install it, run softwareupdate --install-rosetta

You may get a permissions error on step 5 above. If so, run the following, as recommended in the output: sudo chown -R $(whoami) /usr/local/share/zsh /usr/local/share/zsh/site-functions. Retry step 5.

Rationale

If you look back in the version history, you will see it branch off. A large amount of retrospective changes were made, in a branch called clean-start for several reasons:

1. Remove references to Get Into Teaching, where the prototype had originally been copied and pasted from
2. Remove other system files and images that were accidentally brought into the repo
3. DRY up code
4. Update version of the prototype kit to latest version

The master branch reflects the default branch before the changes, and the main branch is the default branch after the changes. The milestones, reflected in the folder structure, should have corresponding tags in both branches.