README.md

Claim funding for mentor training prototype

Claim funding for mentor training is a service for schools to claim funding for their general mentors’ training.

This prototype is based on the:

• GOV.UK Design System
• GOV.UK Prototype Kit

Requirements

• Node.js - version 20.x.x

Installation

• Clone this repository to a folder on your computer
• Open Terminal
• In Terminal, change the path to the repository
• Type npm install to install the dependencies

Working locally

• In Terminal, change the path to the repository
• Type npm run dev and start the application

Generating data

The prototype uses JSON files to store data and includes a set of seed data.

The seed data is copied to the working data directory (app/data/dist) when you run npm install.

You can also regenerate the data:

• In Terminal, change the path to the repository
• Type npm run generate-data

Environment variables

The prototype uses environment variables to help configure the application:

Variable	Type	Description
USE_LOGIN	boolean	Use to turn on/off username and password login. If set to false, the login screen displays a list of test personas. Values: true or false
SHOW_START_PAGE	boolean	Use to turn on/off showing the example start page. Values: true or false

Tools

If you’re using Visual Studio (VS) Code for prototyping, we recommend you install the following extensions:

• GOV.UK Design System snippets
• EditorConfig for VS Code
• Nunjucks for VS Code
• Nunjucks snippets

We also recommend you update your VS Code settings to make sure you’re trimming whitespace: Files: Trim Trailing Whitespace.