CMPUT 174 Development Environment

This repository contains everything you need to create a standard development environment for your CMPUT 174 assignments. In addition to the development environment, a standard project structure has also been provided in which to write your solutions. Please refer to the instructions and videos below to setup your environment.

Step 1: Install Docker (Windows)

1. Open the Windows Powershell as an Administrator by typing "PowerShell" into the Windows search bar, right-clicking "Windows PowerShell", and selecting "Run as administrator".
2. Install WSL2 by running the command wsl --install in Windows PowerShell.
3. Once installation is complete, reboot your device.
4. Upon reboot, an Ubuntu terminal should open automatically. If not, select "Ubuntu" from the start menu.
5. You should see the message "Installing, this may take a few minutes...". Upon completion (this may take a while) you will be prompted to set your username and password.
6. Update your Linux packages by running sudo apt update && sudo apt upgrade
7. Install Docker Desktop by following these instructions.
8. To confirm your installation was successful, run the following commands in either Windows Powershell or an Ubuntu Terminal:

docker --version
docker run hello-world

Follow these instructions or seek TA's help if you see the following error message: Please enable the Virtual Machine Platform Windows feature and ensure virtualization is enabled in the BIOS.Ensure that virtualization has been enabled on your device.

Step 1: Install Docker (Linux & Mac)

1. Installation instructions for both Linux and Mac can be found here.

Step 2: Create Environment (Linux, Windows, Mac)

1. Install Visual Studio Code. Follow this link to download the installer for macOS, Windows, and Linux.
2. Open Visual Studio Code.
3. Refer to the video "Installing Dev Containers" below for a demonstration of the following instructions. Install the Dev Containers extension for Visual Studio Code. To do so, select the Extensions menu from the panel on the left side of the window and enter Dev Containers in the search bar. Finally, click the Install button to add the extension to Visual Studio.
4. Refer to the video "Creating The Development Environment" below for a demonstration of the following instructions. Click the icon (typically blue or green) in the bottom-left corner of the window. In the menu that pops up, select Clone Repository In Container Volume and enter the URL of this repository (https://github.com/UAlberta-CMPUT174/cmput174-dev).
5. For a demonstration of setting the Python interpreter (should be set by default), running scripts, or restoring a previous session after closing Visual Studio Code, refer to the corresponding videos below.

Video: Installing Dev Containers

InstallRemoteContainers.mp4

Video: Creating The Development Environment

CreatingDevEnvironment.mp4

Video: Setting The Python Interpreter

SettingInterpreter.mp4

Video: Running Scripts In Visual Studio Code

RunningCode.mp4

Video: Restoring A Previous Session

RestoringSession.mp4