Publish Teacher Training

Development setup

1. Install build dependencies

Install asdf-vm.

Install the plugins and versions specified in .tool-versions

asdf plugin add ruby
asdf plugin add nodejs
asdf plugin add yarn
asdf install

When the versions are updated in master run asdf install again to update your installation.

(We don't mandate asdf, you can use other tools if you prefer.)

2. Run the builds

Run the following commands:

yarn
bundle
bundle exec rake webpacker:compile

3. Run the server

1. Run bundle exec rails s to launch the app on https://localhost:3000.

You'll need a running teacher-training-api.

Docker

Install Docker and Docker Compose.

docker-compose up --build

Warning: Running docker seems to slow down local development significantly on macOS.

Running specs

Note: the rspec tests will fail until the site has been run for the first time.

bundle exec rspec

Running specs in parallel

# This uses the max available cores
bundle exec rails parallel:spec

# Modify the number of cores
bundle exec rails parallel:spec[number]

Running specs and linter (SCSS and Ruby)

NB: This will run specs in parallel using the maximum cores available. To change the number of cores set the following environment variable - PARALLEL_CORES.

bundle exec rake

Or through guard (--no-interactions allows the use of pry inside tests):

bundle exec guard --no-interactions

Linting

It's best to lint just your app directories and not those belonging to the framework, e.g.

bundle exec rubocop app config lib spec Gemfile --format clang -a

or

bundle exec govuk-lint-sass app/webpacker/styles

Secrets vs Settings

Refer to the the config gem to understand the file based settings loading order.

To override file based via Machine based env variables settings

cat config/settings.yml
file
  based
    settings
      env1: 'foo'

export SETTINGS__FILE__BASED__SETTINGS__ENV1="bar"

puts Settings.file.based.setting.env1

bar

Refer to the settings file for all the settings required to run this app

Sentry

To track exceptions through Sentry, configure the SENTRY_DSN environment variable:

SENTRY_DSN=https://aaa:bbb@sentry.io/123 rails s

Authentication Mode

There are 3 mutually exclusive ways to login

• Non-Production environments

  • persona

• Production environments

  • dfe_signin
  • magic_link

Persona login

Persona login is available in local development and non-production environments. This allows you to log in to existing anonymised accounts or pre-selected accounts identified by personas.

Basic auth is enabled by default for this Authentication Mode. The credentials can be found in the Confluence pages.

DfE Sign-in & magic

DfE Sign-in is third party and also the default Authentication Mode.

When DfE Sign-in is not available, a fallback Authentication Mode called magic_link can be used instead.

Additional configuration will be required for either Authentication Modes.

You likely already have an account for certain environments, but you will need to ensure you have an account in the DfE Sign-in test environment to be able to login locally. Check with team members on how to do this.

Configure DfE Sign-in

Create the following file and ask the team for the secret.

# config/settings/development.local.yml
dfe_signin:
    secret: dfe_sign_in_test_server_client_secret_here

Trust the TLS certificate

Depending on your browser you may need to add the automatically generated SSL certificate to your OS keychain to make the browser trust the local site.

On macOS:

sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain config/localhost/https/localhost.crt

Run The Server in SSL Mode

You'll have to configure the server to run in SSL mode by setting the environment variable SETTINGS__USE_SSL, for example, use this command to run the server:

SETTINGS__USE_SSL=1 rails s