• Ruby 3.1.0
• NodeJS 16.13.x
• Yarn 1.22.x

The .tool-version file in the root of the repository is used to specify the runtime versions of ruby and node.

1. Download and install asdf-vm 🔗

2. Install ruby and node plugins

   asdf plugin add ruby
   asdf plugin add nodejs
   

3. Then run asdf install to install the ruby and node versions specified in the .tool-versions file.

1. Run bundle install to install the gem dependencies
2. Run yarn to install node dependencies
3. Run bundle exec rails server to launch the app on http://localhost:3002

By default, in development mode Find will pull course data from the live Publish service.

To pull course data from a local copy of Publish, create a file at config/settings/development.local.yml with the following contents:

teacher_training_api:
  base_url: http://localhost:3001 # this is the default Publish port

(Git will ignore this file.)

bundle exec rake

bundle exec rspec

Application is hosted on GOV.UK PaaS and every merged PR is continuously deployed to Production.

• Deployment Workflow
• Getting started with PaaS

We inherit the Rubocop config from Apply for teacher training. To pull the latest version, run bundle exec rake rubocop:copy_config_from_apply. Then to run Rubocop:

bundle exec rubocop -a

(-a will auto-correct violations where possible)

bundle exec scss-lint app/webpacker/styles

Environment variables and app secrets for each environment are stored in Azure KeyVault and gets applied each time the application is deployed. There are make commands which assist in viewing/editing these environment variables from a local console. Please note that you need to have the az cli installed for this to work.

You also need an activated PIM request to view/edit secrets all environments except qa.

From the root of the repository run the below command, for environments other than qa, make sure you have an activated PIM request

make <qa|staging|sandbox|production> print-app-secrets

From the root of the repository run the below command, for environments other than qa, make sure you have an activated PIM request

make <qa|staging|sandbox|production> edit-app-secrets

This will present the app secrets in YAML format in your editor (vim), you can make changes to the file and once saved, the secrets will be uploaded to KeyVault and applied to the app after the subsequent deployment.