| Table of Contents |
|---|
Step 1 - Guide Prerequisite:
At the time of writing this documentation, the following is a pre-requisite to the rest of the guide.
Make sure you have permission to install the software you are about to install. Check with your team first.
Make sure you have local administrator rights on your issued device.
Make sure you are added to the proper Active Directory Group. If you run into permission issues during the rest of the guide, you are probably not “included“ to something. Just check with your team.
Make sure you are able to connect to the Government of Canada Secure Remote Access (GCSRA) service. aka Cisco AnyConnect Secure Mobility Client
Step 2 - Visual Studio:
First, inquire with the team you are working with about the development software they are using. At the time of writing this document, the IDE used by Team Kraken was Visual Studio. You are also entitled to a Professional license of Visual Studio, so prior to implementing this step make sure you check with your team about how to submit a request to get your account subscribed to the Visual Studio Subscriptions group.
Step 2.1 - Download
Head over to your Visual Studio Professional Subscription, and under:
...
After you click the download button, you will be directed to the thank you page from Microsoft and your download will be begin shortly afterwards.
Step 2.2 - Installation
Launch the Visual Studio Installer and accept the UAC prompt.
...
The Visual Studio Installer will commence the download of the workload items and install them. Wait for it to complete, then proceed to the configuration section.
Step 2.3 - Configuration
After launching visual studio you will be directed to the landing page. Click on the Clone a repository.
Set the path for where you want to clone the repositories.
Under the Browse a repository
Click on Azure DevOps and link your TC account if it is not already linked. Then expand DSD-MARINE Vessel Registry and click on the Vessel Registration and click on the Clone button.
Click on GitHub and link your TC Account if it is not already linked. Search for and select the tc-ca/DSD-Marine-Blazor-Components and click on the clone button.
...
The previous step(s) will clone the current projects required to commence work. In the future, there might be additional repositories but the process of cloning will be the same.
Once the repository cloning is completed select any of the cloned repositories or continue into the editor by selecting “Continue without code“.
...
We are going to need to add the custom Nuget packages, so the following steps will guide you on where to acquire them and how to load them into your project:
Proceed to the Azure DevOps page and select the DSD-MARINE Vessel Registry project
On the left side menu select the Artifact menu option
Make sure the DevOps-Nuget Package is selected in the drop down
Click on the Connect to feed
Select Visual Studio from the list
Under the Machine Setup Section note the Name and the Source, copy both of them
In Visual Studio’s menu => Tools/NuGet Package Manager/Package Manager Settings
Under the NuGet Package Manager collapse click on Package Sources
Click on the Green Plus Icon
Set the Name to match that of the Artifacts section from earlier, and the source to value copied from the Source Section.
Finally depending on the project you are running, there might be some user secrets that are required to allow the project to function properly. Consult with the team, and they will instruct/provide you with required secrets to include in your project.
Step 3 - Install Docker (Windows):
Step 3.1 - Download
Proceed to the docker desktop download page, and select the Download for Windows.
...
After the download completes, start the executable, accept the admin prompt dialog box, and proceed to the next step (3.2 - Installation).
Step 3.2 - Installation
On the pre-installation screen, uncheck the Install required Windows components for WSL 2, and click the Ok button.
...
Wait for the Docker installer to unpack the required files and install them. After which you will be prompted to restart you PC. Click on the Close and restart.
...
Step 3.3 - Configuration
Verify Docker is running by looking inside the system tray for Docker’s icon. Right click on the icon, then select the Settings menu option.
...
On the settings page:
Select the resource group
Click on File Sharing
Click on the add button icon
Set the directory to the C drive root
...
Step 4 - pgAdmin - PostgresSQL Tools:
Step 4.1 - Download:
Navigate to the pgAdmin website download page and download the Windows pgAdmin 4 tool.
...
This will take you to the “real“ download page:
...
Step 4.2 - Installation:
Launch the pgAdmin installer and click on the “Yes“ button on the UAC prompt.
...
After the installation is finished, launch pgAdmin and proceed to the 4.3 configuration section.
Step 4.3 - Configuration:
When pgAdmin starts for the first time it will prompt you to enter a master password for accessing the local instance of your pgAdmin application. Enter a password you will remember, you will need to enter it every time you start the pgAdmin application.
...
Once you are on the main screen:
Right click on the Servers Group
Hover over the Create menu item, which will open the sub-menu
Click on Server
...
The Create - Server dialog will appear. In the Name field enter a name that best describes the database you are trying to connect to. This field is just used as an identifier, as you can have many server instances created. You can leave the defaults for the other fields.
...
After entering the name, click on the Connections tab. In the connections tab section there are sensitive data which are stored in the Azure Portal Key Vault. You will need to check with your team about there location.
Click on the Connection tab
Azure Key Vault derived values (Check with the team):
Host name/address
Maintenance database
Username
Password
For the Port field, you can leave the default value of 5432, and the same for the other non Azure Key Vault Derived values.
After you are done entering the values in the Connections tab, click on the Save button.
...