Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 4.34 KB

README.md

File metadata and controls

94 lines (59 loc) · 4.34 KB
Raw

Service Insights

CI/CD Pull Request Quality Gate Status

Code repository for the Service Insights product, part of the National Screening Platform (NSP).

Table of Contents

Setup

Clone the repository

git clone https://github.com/NHSDigital/dtos-service-insights.git
cd dtos-service-insights

Prerequisites

The following software packages, or their equivalents, are expected to be installed and configured:

Configuration

  1. Select the NHS DToS profile as your VS Code profile to install all the recommended VS Code extensions

  2. Set up local settings

  3. Set up local database

  4. Set up commit signing

Usage

  1. Start the Azurite Blob Service and Azurite Queue Service

  2. Run func start in the folder of each function project you wish to run

Testing

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.

Design

Diagrams

The C4 model is a simple and intuitive way to create software architecture diagrams that are clear, consistent, scalable and most importantly collaborative. This should result in documenting all the system interfaces, external dependencies and integration points.

Repository Template

Modularity

Most of the projects are built with customisability and extendability in mind. At a minimum, this can be achieved by implementing service level configuration options and settings. The intention of this section is to show how this can be used. If the system processes data, you could mention here for example how the input is prepared for testing - anonymised, synthetic or live data.

Contributing

Describe or link templates on how to raise an issue, feature request or make a contribution to the codebase. Reference the other documentation files, like

  • Environment setup for contribution, i.e. CONTRIBUTING.md
  • Coding standards, branching, linting, practices for development and testing
  • Release process, versioning, changelog
  • Backlog, board, roadmap, ways of working
  • High-level requirements, guiding principles, decision records, etc.

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.