README.md

README

About

Live version of the service can be find here: https://find-a-teaching-school-hub.education.gov.uk/

Setup

Prerequisites

This project depends on:

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

Updating Hub File

When updating the db/data/hubs.csv file, please make sure to run rails r 'Hub::Importer.new.reload!' locally first to make sure all changes were applied.

Testing

Mocking with VCR for feature specs

Your default test geocoder key should be ORDNANCE_SURVEY_API_KEY='geocoderkey', and its VERY IMPORTANT not to leak key to the repository. This key is being set in github actions as well. Every time you re-record VCR cassete, you need to modify the key.

Linting

To run the linters:

bin/lint

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,