Skip to content

NHSDigital/dtos-cohort-manager

Repository files navigation

Cohort Manager

CI/CD Pull Request Quality Gate Status

A service for identifying and managing cohorts of citizens. Users can select individuals to be part of a cohort, based on rules which are set by central bodies,
or they can select individuals on an ad-hoc basis when planning their capacity. Rules for selecting individuals can be based on both demographic and medical criteria.

Table of Contents

Set-up

Prerequisites

1. Import the NHS DToS Profile

To easily install the required extensions and settings/configuration for VS Code, you can import the profile located in Set-up/NHS_DToS.code-profile

On the top toolbar of Visual Studio Code go to Code > Settings > Profiles > Import Profile > click on Select File... and select the file NHS_DToS.code-profile

2. Azure Data Studio & Storage Explorer

Azure Data Studio & Storage Explorer are the GUI tools we are using to manually interact with the database & Azure Storage respectively.

Use the Intel Chip/ x64 installer if you have and Intel Chip in your Mac. Otherwise, use the Apple Silicon/ ARM64 installer.

Note: to check which version you are using, you can click on the Apple icon of your machine > About this Mac and a new window will appear. You can see the Chip your machine. Intel will have Intel in it, Apple Silicon will have something like Apple M1.

3. Download Docker/ Podman

If you are on Windows, install Docker Engine using these instructions

If you are on Mac, install Podman by running:

brew install --cask podman
brew install podman-compose

# Allocate sufficient resources to Podman:
podman machine stop
podman machine set --cpus=6 --memory=12288 --disk-size=125
podman machine start

4. Optional: Azure Functions Core Tools

Install only if you plan on running the functions outside of Docker/ Podman

Azure Function Core Tools lets you develop and test your functions on your local computer. To install, press ctrl/ command + shift + P and enter Azure Functions: Install or Update Azure Functions Core Tools

Configuration

Copy the .env.example file, rename it to just ".env", and follow the instructions inside the file to add the variables.

Note: For existing users, make sure you replace where it says 127.0.0.1 in the azurite connection string and replace it with "azurite"

Usage

After a successful installation, please follow this User Guide to use the application.

Testing

Unit tests can be run from the Functions directory with dotnet test

To run the end-to-end tests, follow the instructions in the playwright-tests directory

Contributing

To contribute, follow the instructions in the contributing.md

Contacts

Provide a way to contact the owners of this project. It can be a team, an individual or information on the means of getting in touch via active communication channels, e.g. opening a GitHub discussion, raising an issue, etc.

Licence

The LICENCE.md file will need to be updated with the correct year and owner

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

Any HTML or Markdown documentation is © Crown Copyright and available under the terms of the Open Government Licence v3.0.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 42