|
1 | | -<h2>To get started, clone the source code</h2> |
2 | | -<div style="margin-left:18px;"> |
3 | | -1. Create a folder called CDR<br /> |
4 | | -2. Navigate to this folder<br /> |
5 | | -3. Clone the repo as a subfolder of this folder using the following command;<br /> |
6 | | -<div style="margin-left:18px;"> |
7 | | -git clone https://github.com/ConsumerDataRight/authorisation-server.git<br /> |
8 | | -</div> |
9 | | -4. Install the required certificates. See certificate details <a href="../../CertificateManagement/README.md" title="Certificate Management" alt="Certificate Management - CertificateManagement/README.md"> here</a>.<br /> |
10 | | -5. Start the projects in the solution, can be done in multiple ways, examples below are from .Net command line and using MS Visual Studio<br /> |
11 | | -</div> |
12 | | - |
13 | | -<h2>.Net command line</h2> |
14 | | -<div style="margin-left:18px;"> |
15 | | -<p>1. Download and install the free <a href="https://docs.microsoft.com/en-us/windows/terminal/get-started" title="Download the free Windows Terminal here" alt="Download the free MS Windows Terminal here">MS Windows Terminal</a> |
16 | | -<br /> |
17 | | -2. Use the <a href="../../Source/Start-Auth-Server.bat" title="Use the Start-Auth-Server .Net CLI batch file here" alt="Use the Start-Auth-Server .Net CLI batch file here">Start-Auth-Server</a> batch file to build and run the required projects to start the Mock Data Holder. |
18 | | -</p> |
| 1 | +# Getting Started |
| 2 | +To get started, clone the source code from the GitHub repositories by following the steps below: |
| 3 | + |
| 4 | +1. Create a folder called CDR. |
| 5 | +2. Navigate to this folder. |
| 6 | +3. Clone the repo as a subfolder of this folder using the following command: |
| 7 | +``` |
| 8 | +git clone https://github.com/ConsumerDataRight/authorisation-server.git |
| 9 | +``` |
| 10 | +4. Install the required certificates. See certificate details [here](../../CertificateManagement/README.md "Certificate Management"). |
| 11 | +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. |
| 12 | + |
| 13 | +## .Net command line |
| 14 | + |
| 15 | +1. Download and install the free [MS Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/get-started "Download the free Windows Terminal here"). |
| 16 | +2. Use the [Start-Auth-Server](../../Source/Start-Auth-Server.bat "Use the Start-Auth-Server.bat .Net CLI batch file here") batch file to build and run the required projects to start the Mock Data Holder. |
| 17 | + |
19 | 18 |
|
20 | 19 | [<img src="./images/DotNet-CLI-Running.png" width='600' alt="Start projects from .Net CLI"/>](./images/DotNet-CLI-Running.png) |
21 | | -<br /> |
22 | | -This will create the LocalDB database by default and seed the database with the supplied sample data. |
23 | | -<p>LocalDB is installed as part of MS Visual Studio. If using MS VSCode, the MS SQL extension will need to be installed.</p> |
24 | | -<p>You can connect to the database from MS Visual Studio using the SQL Explorer, or from MS SQL Server Management Studio (SSMS) using |
25 | | - the following settings; <br /> |
26 | | - Server type: Database Engine <br /> |
27 | | - Server name: (LocalDB)\MSSQLLocalDB <br /> |
28 | | - Authentication: Windows Authentication<br /> |
29 | | -</p> |
30 | | -</div> |
31 | | - |
32 | | -<h2>MS Visual Studio</h2> |
33 | | -<div style="margin-left:18px;"> |
34 | | -<p>To launch the application using MS Visual Studio, the following projects need to be started:</p> |
35 | | -<p> CdrAuthServer <br /> |
36 | | - CdrAuthServer.mTLS.Gateway <br /> |
37 | | - CdrAuthServer.TLS.Gateway<br /> |
38 | | -</p> |
39 | | - |
40 | | -<p>1. Navigate to the solution properties and select a "Start" action for the required projects.</p> |
| 20 | + |
| 21 | +This will create the LocalDB instance by default and seed the database with the supplied sample data. |
| 22 | + |
| 23 | +LocalDB is installed as part of MS Visual Studio. If using MS VSCode, the MS SQL extension will need to be installed. |
| 24 | + |
| 25 | +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: |
| 26 | +``` |
| 27 | +Server type: Database Engine |
| 28 | +Server name: (LocalDB)\\MSSQLLocalDB |
| 29 | +Authentication: Windows Authentication |
| 30 | +``` |
| 31 | +## MS Visual Studio |
| 32 | + |
| 33 | +### Start the Mock Data Holder |
| 34 | +To launch the application using MS Visual Studio, the following projects need to be started: |
| 35 | +``` |
| 36 | +CdrAuthServer |
| 37 | +CdrAuthServer.mTLS.Gateway |
| 38 | +CdrAuthServer.TLS.Gateway |
| 39 | +``` |
| 40 | + |
| 41 | +1. Navigate to the solution properties and select a "Start" action for the required projects. |
41 | 42 |
|
42 | 43 | [<img src="./images/MS-Visual-Studio-Select-projects.png" width='600' alt="Project selected to be started"/>](./images/MS-Visual-Studio-Select-projects.png) |
43 | | -<br /> |
44 | | -<p>2. Click "Start" to start the Authorisation Server solution.</p> |
| 44 | + |
| 45 | +2. Click "Start" to start the Authorisation Server solution. |
45 | 46 |
|
46 | 47 | [<img src="./images/MS-Visual-Studio-Start-No-Debug.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start-No-Debug.png) |
47 | | -<br /> |
48 | | -Output windows will be launched for each of the projects set to start. <br /> |
49 | | -These will show the logging messages as sent to the console in each of the running projects. E.g.<br /> |
| 48 | + |
| 49 | +3. Output windows will be launched for each of the projects set to start. \ |
| 50 | + These will show the logging messages as sent to the console in each of the running projects. E.g. |
| 51 | + |
50 | 52 | [<img src="./images/MS-Visual-Studio-Running.png" width='600' alt="Project running"/>](./images/MS-Visual-Studio-Running.png) |
51 | | -<br /> |
52 | | -To run the solution in debug mode, simply follow the steps outlined above and click on the "Start" button as shown in the image below: <br /> |
53 | | -[<img src="./images/MS-Visual-Studio-Start.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start.png) |
54 | 53 |
|
55 | | -</div> |
| 54 | +4. To run the solution in debug mode, simply follow the steps outlined above and click on the "Start" \ |
| 55 | + button as shown in the image below: |
| 56 | + |
| 57 | +[<img src="./images/MS-Visual-Studio-Start.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start.png) |
0 commit comments