lgtm-migrator / dfe-complete-conversions-transfers-and-changes

An application to help the process of schools converting to academies, transferring between academy trusts or changing their academy status.

DfE: Complete conversions, transfers and changes

As a digital service being developed in DfE we aim to follow the DfE Technical Guidance.

Environments

• development
• test
• production

Shared components and patterns

• DfE GOV.UK Components
• DfE GOV.UK Form Builder
• GOV.UK Frontend
• GOV.UK Accessible autocomplete
• MOJ Frontend
• dxw Mail Notify

Getting started

If this is your first time running the application, see the getting started documentation for instructions.

Additional documentation

• The workflow files
• User accounts
• Microsoft SQL Server

Running a server

To start a local server, run script/server. Once started the application is available at http://localhost:3000/.

Testing

To run the test suite, run script/test.

Reducing test scope

You can optionally use ONLY_LINTING and ONLY_APP_TESTS environment variables to selectively run either linting/formatting/schema tests or application tests respectively, for example

ONLY_LINTING=1 script/test

Fixing formatting

By default, linters will cause a test failure if there are formatting problems. However, you can automatically fix formatting in many cases by using the AUTO_FIX_FORMATTING environment variable:

AUTO_FIX_FORMATTING=1 script/test

This can also be combined with the reduced scopes for fast formatting fixes, for example:

AUTO_FIX_FORMATTING=1 ONLY_LINTING=1 script/test

Environment variables

See .env.example

For production environments, additional variables are required

Releases and deployments

See releases and deployments

ADRs

You can find the ADRs for this project in the doc/decisions folder.

Errors and monitoring

We use sentry.io to monitor errors and the performance of the application.

Infrastructure

We use infrastructure as code (Terraform) to deploy and manage resources hosting the app. This is stored in the terraform directory.

Documentation: terraform/README.md