This repository contains the infrastructure and code required to deliver letters digitally that would traditionally be printed and posted.
NHS Trusts currently generate a high volume of letters for patients and other care providers, most of which are still sent in printed form. This project enables those letters to be delivered through the NHS App in digital form, with a fallback to printed letter.
Located in src directory.
Clone the repository
git clone https://github.com/NHSDigital/nhs-notify-digital-letters.git
cd nhs-notify-digital-letters
code project.code-workspaceReopen with container
make debugThe following software packages, or their equivalents, are expected to be installed and configured:
- Docker container runtime or a compatible tool, e.g. Podman, Rancher
- asdf version manager,
- GNU make 3.82 or later,
Note
The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain make tasks will fail. On macOS, you will need Homebrew installed, then to install make, like so:
brew install makeYou will then see instructions to fix your $PATH variable to make the newly installed version available. If you are using dotfiles, this is all done for you.
- GNU sed and GNU grep are required for the scripted command-line output processing,
- GNU coreutils and GNU binutils may be required to build dependencies like Python, which may need to be compiled during installation,
Note
For macOS users, installation of the GNU toolchain has been scripted and automated as part of the dotfiles project. Please see this script for details.
Installation and configuration of the toolchain dependencies
make configNote that the make config command will also build the flattened event schemas and auto-generate a Typescript
type and JS validator code for each event. See the typescript-schema-generator
package for more details.
There are make tasks for you to configure to run your tests. Run make test to see how they work. You should be able to use the same entry points for local development as in your CI pipeline.
This section contains automatically generated documentation for CloudEvents schemas.
No common schemas defined yet.
Purpose: Production domain for digital letters events
NHS Notify Team
Ross Buggins - ross.buggins@nhs.net
Thomas D'Roza - tom.droza2@nhs.net
The source code for the repository's documentation can be found under /docs and is deployed by the CD pipeline to NHS Notify Digital Letters.