Register of training providers prototype

The ‘Register of training providers’ is a proof of concept for DfE and, more specifically, Becoming a teacher (BAT) to manage a canonical list of training providers.

This prototype is based on the:

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

You can read more about this register on the design history website.

Documentation

• Architecture documentation - Technical architecture, design patterns, and codebase structure
• Deployment guide - Deployment instructions for various platforms and environments
• Design history - Service and design context

Requirements

• Node.js 22.x
• npm (compatible with Node 22)

Quick start

git clone <repository-url>
cd register-training-providers-prototype
npm install          # installs deps and builds the dev SQLite DB
npm run dev          # start with live reload

Generating data

The prototype uses a SQLite database to store data and includes a set of seed data.

The database is built automatically during npm install. To rebuild with fresh seed data:

npm run db:build:dev

Environment variables

The prototype uses environment variables to configure runtime and integrations:

Variable	Type	Description
ORDNANCE_SURVEY_API_KEY	string	The API key needed to access the Ordnance Survey Places API
ORDNANCE_SURVEY_API_SECRET	string	The API secret needed to access the Ordnance Survey Places API
SESSION_SECRET	string	Secret used to sign session cookies
API_CLIENT_TOKEN_SECRET	string	Secret used to hash and validate API client tokens
USE_SIGN_IN_FORM	boolean (true/false)	Whether to use the sign-in form instead of personas (default true)

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.