Required Accounts, Software, & Applications

This page is a step-by-step guide on how to create, install, and download all necessary accounts, software, and applications required to work on the website.

Create A GitHub (opens in a new tab) account

GitHub is used as a "remote repository", in Layman's terms, GitHub keeps all of our files, and stores them on their servers, where we can access them. Follow this guide (opens in a new tab) to setup your account.

Install git (opens in a new tab)

Do not confuse git with GitHub, git is a "Global Information Tracker", which essentially means that it keeps track of who makes what changes to any and all files in our project. GitHub however, is simply a website which stores our files, and is built around the concept of git. This YouTube video (opens in a new tab) should show you how to install git.

If you do not have administrative privileges on your computer, you will need to use the portable version of git.

Download Visual Studio Code (opens in a new tab)

Visual Studio Code is an IDE (Integrated Development Environment) meaning it is designed to help you write code (or other files in this case).

Steps 4, and 5 are only necessary if you want to run the website on your computer, this requires having administrative privileges however. If you do not have administrative privileges, you can still preview the website, it is just less convenient. You can find more info here.

Download and install Node.js (opens in a new tab)

Node.js is the code that runs the web server.

Download and install pnpm (opens in a new tab)

pnpm is a package manager, which manages dependencies for the project.

Restart your computer

It is a good idea to restart your computer to ensure all applications are fresh.

Read the bring-ups

Congratulations, you have finished this step, continue by reading the bring-ups following this document. This will give you the understanding required to edit any page!

Website Documentation Bring-Up: Project Structure