Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.09 KB

HELP.md

File metadata and controls

64 lines (45 loc) · 3.09 KB
Raw

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-register.git
  1. Install the required certificates. See certificate details here.
  2. 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.

Run solution using .Net command line

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

Start projects from .Net CLI

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

Run solution using MS Visual Studio

Start the Mock Register

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

CDR.Register.API.Gateway.mTLS
CDR.Register.API.Gateway.TLS
CDR.Register.Infosec
CDR.Register.Discovery.API
CDR.Register.SSA.API
CDR.Register.Status.API
CDR.Register.Admin.API

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

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

Projects selected to be started

  1. Click "Start" to start the Mock Register solution.

Start the projects

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.

Projects running

Debugging using MS Visual Studio

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

Debug Mock Register