HELP.md

Getting Started

To get started, clone the source code from the GitHub repositories by following the steps below:

1. Create a folder called CDR.
2. Navigate to this folder.
3. Clone the repo as a subfolder of this folder using the following command:

git clone https://github.com/ConsumerDataRight/mock-data-holder-energy.git

4. Install the required certificates. See certificate details here.
5. Start the projects in the solution. This can be done in multiple ways. This guide explains how to do this using .Net command line and using MS Visual Studio.
6. Clone the Authorisation Server repository as a subfolder of CDR folder using the following command:

git clone https://github.com/ConsumerDataRight/authorisation-server.git

Run solution using .Net command line

1. Download and install the free MS Windows Terminal.
2. Use the Start-Data-Holder-Energy batch file to build and run the required projects to start the Mock Data Holder Energy.

This will create the LocalDB instance by default and seed the database with the supplied sample data.

LocalDB is installed as part of MS Visual Studio. If using MS VSCode, the MS SQL extension will need to be installed.

You can connect to the database from MS Visual Studio using the SQL Explorer, or from MS SQL Server Management Studio (SSMS) using the following settings:

Server type: Database Engine  
Server name: (LocalDB)\\MSSQLLocalDB  
Authentication: Windows Authentication  

3. Use the Start-Auth-Server-Standalone batch file to build and run the required projects to start the Authorisation Server.

An output window will be launched for the Authorisation Server project showing the logging messages as sent to the console. E.g.

Run solution using MS Visual Studio

Start the Mock Data Holder Energy

To launch the Mock Data Holder Energy solution using MS Visual Studio, the following projects need to be started:

CDR.DataHolder.API.Gateway.mTLS
CDR.DataHolder.Resource.API
CDR.DataHolder.Public.API
CDR.DataHolder.Manage.API

The following steps outline describe how to launch the Mock Data Holder Energy solution using MS Visual Studio:

1. Navigate to the solution properties and select a "Start" action for the required projects.

2. Click "Start" to start the Mock Data Holder Energy solution.

Output windows will be launched for each of the projects set to start. These will show the logging messages as sent to the console in each of the running projects. E.g.

Start the Authorisation Server

The Authorisation Server project needs to be running when using the Mock Data Holder Energy. The Authorisation Server can be run in headless mode or headed mode. In headless mode, the Authorisation Server UI is bypassed. If you choose to run in headed mode, the Authorisation Server UI (React application) needs to be started separately to allow for the UI to be displayed. To accommodate these different modes, the Authorisation Server solution has the following Visual Studio launch profiles:

MDHE-CdrAuthServer – Run the Authorisation Server in headed mode.
MDHE-CdrAuthServerHeadless – Run the Authorisation Server in headless mode.
MDHE-CdrAuthServerWorkingWithContainers - Run the Authorisation Server in headed mode and support integration with Docker containers.

When running the Authorisation Server in headed mode, follow the instructions here to start the React application.

1. Open the Authorisation Server solution (cloned to CDR\Authorisation-Server) in Visual Studio.

2. Select the Visual Studio launch profile you would like to use.

3. Click "Start" to start the Authorisation Server.

An output window will be launched for the Authorisation Server project showing the logging messages as sent to the console. E.g.

Debugging using MS Visual Studio

To run the Mock Data Holder Energy in debug mode, simply follow the steps outlined above and click on the "Start" button as shown in the image below: