This codebase is an example of a "Service Directory" written in .NET using the GOV.UK frontend, following the GDS as faithfully as possible. It includes a postcode search and a large set of mocked services belonging to locations within the vicinities of them.

The intention of the project is to demonstrate a simple full stack .NET Application with a clean architecture approach using an official frontend library, and is heavily inspired by a project I worked on named Family Hubs.

.
|- src
    |- ServiceDirectory.Application
    |- ServiceDirectory.Domain
    |- ServiceDirectory.Infrastructure.Data
    |- ServiceDirectory.Infrastructure.Postcode
    |- ServiceDirectory.Presentation.Web
    |- ServiceDirectory.Presentation.Web.Node

• ServiceDirectory.Application - Contains business logic on behalf of the Presentation layer(s), interfacing with the Infrastructure layer(s).
• ServiceDirectory.Domain - Contains POCOs (Plain Old CLR Objects) that is used to pass data between architectural layers.
• ServiceDirectory.Infrastructure.Data - Contains external database connections and facilitates CRUD operations.
• ServiceDirectory.Infrastructure.Postcode - Contains an HTTP client repository connecting to Postcodes.io
• ServiceDirectory.Presentation.Web - Contains the user-facing web application layer.
• ServiceDirectory.Presentation.Web.Node - Contains the GOV.UK frontend NPM package, any custom SCSS and a build system to apply it to ServiceDirectory.Presentation.Web.

In a terminal*..

1. .NET 9 SDK with the ASP.NET Runtime
2. Docker

This project uses Microsoft SQL Server 2022 for the Database. There is a convenient Docker Compose file that will get you up and running quickly:

1. cd into utility and then cd into mssql
2. Execute docker compose up -d

This will work for Windows, macOS and Linux. If you are on Windows (x86-64) specifically, you may also choose to install Microsoft SQL Server 2022 natively — but I recommend going with Docker as it's easier to manage.

1. Make sure you have installed the Prerequisites
2. Make sure you have got the Database running
3. cd into the root of the project that contains ServiceDirectory.sln
4. Execute dotnet restore
5. Execute dotnet build --configuration Release --no-restore

Note: if you wish to update the GOV.UK frontend package, or add custom CSS, this is all done in the ServiceDirectory.Presentation.Web.Node project. Please follow the README in there for instructions on how to update the main project with relevant changes.

1. Make sure you have followed Building
2. cd into src and then cd into ServiceDirectory.Presentation.Web
3. Execute dotnet run --configuration Release --no-build --no-restore

You should now have the Web Application running.

• Firstly, navigate to https://localhost:7024/swagger/index.html as this contains a convenient API for seeding the database with mock data. You can go here and play with it as much as you like, but a minimum of running it once for the first time is required.
• Navigate to https://localhost:7024/ to open the Web Application itself and have a play around!

After the first time, any further runs of the Web App. only require you to go to the UI at https://localhost:7024/ as the mock data is persisted in your database, so further playing around with the API component is optional.

Please note that Docker is required for running the Integration Tests, as they use Testcontainers.

1. Make sure you have followed Building
2. cd into the root of the project that contains ServiceDirectory.sln
3. To run WITH the E2E Tests..
   1. Make sure you have the app up and running: Running
   2. cd into test then ServiceDirectory.Presentation.Web.E2E
   3. Ensure PowerShell is installed, and execute pwsh bin/Release/net9.0/playwright.ps1 install
   4. Make sure you then cd back into the root of the project that contains ServiceDirectory.sln
   5. Execute dotnet test --configuration Release --no-build --no-restore
4. To run WITHOUT the E2E Tests..
   1. Execute dotnet test --configuration Release --no-build --no-restore --filter Category!=E2E

* Your IDE likely has a couple of "Play" or "Test" buttons to press, or you can make a multi-launch config, but these instructions are designed to be universal and as such are platform and IDE agnostic.