The NHS COVID Pass Back End is an API the Covid Pass Front End is utilising. It has integrations with NHSD where medical exemptions and test results are fetched from. The NHS Covid Pass Back End also generates 2D Barcodes for the NHS Covid Pass Front End as well as defining the rules for generating the aforementioned 2D Barcodes. It conducts processes based on a users' actions within the NHS Covid Pass Front End such as sending out emails.
GIT is used for version/source control.
GIT can be installed from here: https://git-scm.com/
You will be prompted to answer a series of questions when installing GIT on Windows. You should select the following two configuration options where possible (otherwise use the default selected):
- Checkout as-is, commit as-is.
- Git Credential Manager for Windows
You will also need to install:
- .NET 6.0 / C# 10 (i.e. Visual Studio 2022 or Rider 2022.2+)
To clone the repository:
- Open a new CMD instance (if installed use git bash) and navigate to the destination directory where you'd like the cloned repository to exist. If necessary, create this folder first.
- Execute the command: git clone https://github.com/ukhsa-collaboration/covid-pass-backend.git
Link to the licence file
https://github.com/ukhsa-collaboration/covid-pass-backend/blob/main/LICENSE
Gitleaks is implemented in this repo. Gitleaks will scan any commit against a list of regex rules to scan. Please follow these steps to setup Gitleaks:
- Install Pre-commit to enable the gitleaks hook
pip install pre-commit
or
py -m pip install pre-commit
- Enable Auto Updates for pre-commit/gitleaks
pre-commit autoupdate
- Install Gitleaks trough pre-commit
pre-commit install
A gitleaks scan will now run automatically on every commit.