Register of training providers

The service for managing the canonical list of training providers for Department for Education (DfE) and, more specifically, Becoming a teacher (BAT).

Setup

Prerequisites

This project depends on:

• Ruby
• Ruby on Rails
• NodeJS
• Yarn
• Postgres

asdf

This project uses asdf, refer to .tool-versions for the actual versions in use. Use the following to install the required tools:

# The first time
brew install asdf # Mac-specific
asdf plugin add ruby
asdf plugin add nodejs
asdf plugin add postgres

# To install (or update, following a change to .tool-versions)
asdf install

When installing the pg gem, bundle changes directory outside of this project directory, causing it lose track of which version of postgres has been selected in the project's .tool-versions file. To ensure the pg gem installs correctly, you'll want to set the version of postgres that asdf will use:

# Temporarily set the version of postgres to use to build the pg gem
ASDF_POSTGRES_VERSION=17.2 bundle install

Intellisense

solargraph is bundled as part of the development dependencies. You need to set it up for your editor, and then run this command to index your local bundle (re-run if/when we install new dependencies and you want completion):

bin/bundle exec yard gems

You'll also need to configure your editor's solargraph plugin to useBundler:

+  "solargraph.useBundler": true,

How the application works

We keep track of architecture decisions in Architecture Decision Records (ADRs).

We use rladr to generate the boilerplate for new records:

bin/bundle exec rladr new title

Running the app

To run the application locally:

1. Run bin/setup --skip-server to setup the app
2. Run bin/dev to launch the app on http://localhost:1025

Linting

To run the linters:

bin/lint

Example Data

To set up the example data for the app run the following

rails example_data:generate

Authentication

To set up local authentication using personas add the following to your environment file:

# .env.local
SIGN_IN_METHOD=persona

Ordnance Survey API Key Setup

1. Sign up at OS Data Hub using your education.gov.uk email.

2. When prompted:

   • Select Public Sector Plan
   • Set Organisation to Department for Education

3. Wait for your account to be approved by the Department for Education account holder.

4. Once approved, go to API projects. You’ll see projects for each environment:

   • Register of Training Providers - Prod
   • Register of Training Providers - Staging
   • Register of Training Providers - QA
   • Register of Training Providers - Review
   • Register of Training Providers - Dev → use this one for local development.

5. Copy the API key from the relevant project and add it to your environment file:

   # .env.local
   ORDNANCE_SURVEY_API_KEY=dev-api-key-here