Cab portal & Register

Requirements:

• Visual Studio or JetBrain Rider
• download and install .NET 8 - https://learn.microsoft.com/en-us/dotnet/core/install/macos
• dotnet tool install --global dotnet-ef --version 8.*
• Node
• NPM

Getting Started

1. Clone repo
2. Install dev certs for https - why
   • dotnet dev-certs https --trust
3. Install docker desktop - is this to install the docker destop application
   • docker run -d --name postgres-container -e POSTGRES_PASSWORD=postgres -p 5432:5432 postgres:15-alpine
4. Install postico or pgadmin4 (or equivalent)
   • create local DB/server
     • host: localhost
     • database: postgres
     • user: postgres
     • password: postgres
5. Add user secrets - ask member of team for them and update the postgres details with the correct credentials - the username and password you created when setting up the database.
6. • Run DB migrations - dotnet ef database update --project DVSRegister.Data --startup-project DVSRegister
7. Install localstack
   • brew install localstack/tap/localstack-cli
   • localstack start -d
   • run docker ps to get the localstack container id (or copy the container ID from Docker Desktop)
   • docker exec -it 'CONTAINER_ID' bash
   • awslocal s3api create-bucket --bucket s3-dvs-dev20240529103145426300000001
   • http://s3-dvs-dev20240529103145426300000001.s3.localhost.localstack.cloud:4566

Note: Make sure to update the s3 bucket in user secrets to use path style instead of host style.

GOV.UK Frontend and Styling

This project relies on the GOV.UK Frontend NPM package which contains images, fonts, styling, and JavaScript.

Updating styles

The project loosely follows and ITCSS folder structure(LINK) and BEM(LINK) for writing CSS If you're adding new styles to the codebase be sure to run npm run compile-sass inside the project folder DVSAdmin.

Contributing

On this project we use Conventional Commits. Conventional Commits establish a formal convention for structuring commit messages.

Development credentials

We store credentials for the dev site inside the UserSecrets of the project. Speak to someone on the team to get these.

Database

At the root of this repo -

1. For adding migrations: run dotnet ef migrations add nameofmigration --project DVSRegister.Data --startup-project DVSRegister
2. For updating changes to local dabase: run dotnet ef database update --project DVSRegister.Data --startup-project DVSRegister

Running cab portal locally

When running the CAB portal locally, you can bypass the login flow (username, password, MFA) by hardcoding values in the BaseController. This is useful for local development and testing.

1. Open BaseController.
2. Replace the following variables with appropriate values: // Hardcoded values for local testing
   • protected string UserEmail => "testemail@dsit.com"; // Replace with a valid user email
   • protected int CabId => 1233; // Replace with the CAB ID from the Cab table
   • protected string Cab => "TEST"; // Replace with the CAB name from the Cab table linked to the user email

Note: Ensure the UserEmail exists in your database and is mapped to the specified CAB. The CabId and Cab values must match the entries in the Cab table for the given user. This approach is for local development only. Do not use hardcoded credentials in production.

Register

• The Register application is publicly accessible and does not require any modifications.
• It serves as the root of the solution and will load automatically when the solution is run.