.Net Core application, based on a service architecture.

You can use either the latest version of Visual Studio or .NET CLI for Windows, Mac and Linux.

This application uses .NET core to provide an API capable of running on Linux or Windows.

For the frontend web application see https://github.com/nhs-digital-gp-it-futures/public-browse

This repo consists of one service to provide multiple resource endpoints for the NHS Digitial Buying Catalogue application using .NET Core and Docker.

The application is broken down into the following project libraries:

• API – defines and exposes the available Buying Catalogue resources to the frontend
• Application – provides the different use cases and functionality for the Buying Catalogue
• Domain – defines the entities and business logic for the application
• Persistence Layer – provides access and storage for the Buying Catalogue data

• .NET Core Version 3.0
• Docker

Before you begin please install .NET Core 3.0 & Docker on your machine.

All scripts are meant to be run in PowerShell from within this directory.

To run the application in a container in development environment, run the following script:

 & '.\Launch Environment.ps1'

You can now access the API in your browser at http://localhost:8080/swagger/index.html.

To stop the application running in a container and to delete the associated images, run the command:

& '.\Tear Down Environment.ps1'

• Attached mode – directs docker-compose output to your CLI

  & '.\Launch Environment.ps1' -a

• Clean mode – removes all images, resources and networks

  & '.\Tear Down Environment.ps1' -c

• Quiet mode – doesn't do a docker ps -a after finishing

  & '.\Launch Environment.ps1' -q

  or

  & '.\Tear Down Environment.ps1' -q

All scripts are meant to be run in bash from within this directory.

To run the application in a container in development environment, run the following script:

bash launch_environment.sh

You can now access the API in your browser at http://localhost:8080/swagger/index.html.

To stop the application running in a container and to delete the associated images:

bash tear_down_environment.sh

• Attached mode – directs docker-compose output to your CLI

  bash launch_environment.sh -a

• Clean mode – removes all images, resources and networks

  bash tear_down_environment.sh -c

• Quiet mode – doesn't do a docker ps -a after finishing

  bash launch_environment.sh -q

  or

  bash tear_down_environment.sh -q

Launch the environment as described above in Running the API.

Secondly, copy and paste the connection string into your User Secrets file. Your file should have this format:

{
  "ConnectionStrings": {
    "BuyingCatalogue": "Data Source=.,1433;Initial Catalog=buyingcatalogue;MultipleActiveResultSets=True;User Id=NHSD;Password=DisruptTheMarket1!"
  }
}

Lastly, run the API – either through your favourite IDE or using your favourite shell. From the solution root directory run

dotnet run --project ./src/NHSD.BuyingCatalogue.API

Integration tests and persistence Tests run against Docker containers of the service, a mock of the document API, and the database.

'.\Launch Environment.ps1' i

& '.\Run Component Tests.ps1'

or via the test runner in your favourite IDE.

& '.\Tear Down Environment.ps1' i

• Attached mode – directs docker-compose output to your CLI

  & '.\Launch Environment.ps1' i -a

• Quiet mode – doesn't do a docker ps -a after finishing

  & '.\Launch Environment.ps1' i -q

  or

  & '.\Tear Down Environment.ps1' i -q

bash launch_environment.sh i

bash run_component_tests.sh

or via the test runner in your favourite IDE.

bash tear_down_environment.sh i

• Attached mode – directs docker-compose output to your CLI

  bash launch_environment.sh i -a

• Quiet mode – doesn't do a docker ps -a after finishing

  bash launch_environment.sh i -q

  or

  bash tear_down_environment.sh i -q

The dacpac deployment takes a few seconds to initialize and complete so it is not unusual for there to be a slight delay between SQL server initializing and the database being ready for use; upon completion Database setup complete is logged to the console.

1. View the logs of the db_deploy container.
2. If the logs contain standard_init_linux.go:211: exec user process caused "no such file or directory", then run dos2unix on the src/NHSD.BuyingCatalogue.Database.Deployment/entrypoint.sh script.

Have you remembered to run Launch Environment.ps1 i :) ?

Additional information on the data migration package can be found in its readme.