To get started, clone the source code from the GitHub repositories by following the steps below:
- Create a folder called CDR.
- Navigate to this folder.
- Clone the repo as a subfolder of this folder using the following command:
git clone https://github.com/ConsumerDataRight/mock-data-recipient.git
- Install the required certificates. See certificate details here.
- 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.
- Download and install the free MS Windows Terminal.
- Use the Start-Data-Recipient batch file to build and run the required projects to start the Mock Data Recipient.
The browser window will be started with the Mock Data Recipient solution.
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
The following steps outline describe how to launch the Mock Data Recipient solution using MS Visual Studio:
-
Open the Mock Data Recipient solution using MS Visual Studio.
-
Select the 'CDR.DataRecipient.WEB' project.
- Click "Start" to start the Mock Data Recipient solution.
An output window will be launched for the Mock Data Recipient showing the logging messages as sent to the console. E.g.
The browser window will be started with the Mock Data Recipient solution.
To run the Mock Data Recipient in debug mode, simply follow the steps outlined above and click on the "Start" button as shown in the image below: