GettingStarted

Getting Started

This page will provide you with information on how to set up your development environment and start contributing to the project.

Setting Up Your General Development Environment

To set up your development environment, you will need to install the following tools:

Git

Git is a distributed version control system that allows you to track changes in your codebase and collaborate with other developers. You can download Git from the official website: https://git-scm.com/.

Visual Studio Code

Visual Studio Code is a lightweight code editor that provides support for various programming languages and tools. You can download Visual Studio Code from the official website: https://code.visualstudio.com/.

Required Extensions

To work on this project, you will need to install the following extensions in Visual Studio Code:

• Dev Container: This extension allows you to open your project in a containerized environment. You can install this extension by searching for "Dev Containers" in the Extensions view (Ctrl+Shift+X). The extension should be published by Microsoft.

Docker Desktop

Windows

WSL 2 is a compatibility layer for running Linux binary executables natively on Windows.

To install WSL 2, follow the instructions below:

1. Open PowerShell as an administrator and run the following command to enable the Windows Subsystem for Linux feature:

wsl --install

2. Restart your computer when prompted.
3. Open the Microsoft Store and search for "Ubuntu". Click on the "Ubuntu" app and install it.
4. Open the Ubuntu app and follow the instructions to set up your Linux environment.

Docker Desktop is a tool that allows you to run Docker containers on your machine. You can download Docker Desktop from the official website: https://www.docker.com/products/docker-desktop. Ensure that you have WSL 2 installed before installing Docker Desktop on windows.

After installing Docker Desktop, you can run the following command to verify the installation:

docker --version

Note: When working with dev containers in windows you will need to clone the repository in the WSL 2 environment. You can access the WSL 2 environment by running the following command in PowerShell:

wsl ~

Now you can clone the repository in the WSL 2 environment and open it in Visual Studio Code using the Dev Container extension.

git clone https://github.com/UoaWDCC/aspa-portal-v3.git

Move into the cloned repository

cd aspa-portal-v3/

Open the repository in Visual Studio Code

code .

You will be prompted to reopen the repository in a container. Click on the "Reopen in Container" button to open the repository in a dev environment.

Mac with Apple Silicon

First of all, you need to install Rosetta 2. Rosetta 2 is a translation process that enables a Mac with Apple silicon to run apps that contain x86_64 instructions.

To install Rosetta 2, follow the instructions below:

Open Terminal and run the following command:

softwareupdate --install-rosetta

Docker Desktop is a tool that allows you to run Docker containers on your machine. You can download Docker Desktop from the official website: https://www.docker.com/products/docker-desktop.

After installing Docker Desktop, you can run the following command to verify the installation:

docker --version

Mac with Intel Processor

There are no additional requirements for Mac with Intel Processor. You can directly install Docker Desktop from the official website: https://www.docker.com/products/docker-desktop.

After installing Docker Desktop, you can run the following command to verify the installation:

docker --version