Skip to main content

0. Setup Assignment

Purpose and Goals​

This assignment walks you through everything you need to install and set up to be prepared for the course. After completing this assignment, you should have all the tools you need to start coding in the course.

note

It is entirely possible that you may already have some of these things installed. If so, just make sure to verify your installation.

Accounts to Create​

Create a GitHub Account if you don't already have one. Be sure to use a personal email address.

Additionally, apply for the GitHub Student Developer Pack. This will give you access to free domains in which you can deploy your projects, and free credits for cloud providers so that you can host your projects.

Things to install on your computer​

Code Editor​

Visual Studio Code (Same IDE used in CS61A) for writing code.

Package Manager​

Package managers are tools that make it generally easier to install other pieces of software. For macOS or linux, install homebrew from the built in terminal which runs zsh (z-shell). For windows, install chocolatey from the built in powershell application, while running the shell as an administrator. Then paste the following command into the terminal or powershell.

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

Verify your installation by typing the following command in terminal or powershell and make sure you get output something like this:

command:

choco

output:

Chocolatey v2.3.0
Please run 'choco -?' or 'choco <command> -?' for help menu.

A Note on Shells​

The shell you use (zsh, bash, powershell, fish) is separate from the application that you use to access your shell. The shell is a command line interface (cli) which allows you to interact with your underlying operating system and do things like create files, run scripts, or manage running processes. The terminal is the application that allows you to type in shell commands for your computer to run. For instance, on MacOS, iTerm2 is a popular alternative to the built in Mac terminal application, but either application can be used with any shell. VSCode also has a built in terminal, but it has a menu for toggling which shell you want the terminal to use.

Besides general productivity benefits, the reason it is important to be familiar with a shell commands is that servers can normally only be interacted with though the a command line shell. Since almost all servers run some version of linux, it makes sense to get familiar with a shell environment that you can use with linux. Bash is the default shell on most linux distributions, and although MacOS uses zsh by default, zsh is a direct descendent from bash and almost all commands behave the same between on both shells. PowerShell on the other hand, was developed specifically for use on Windows, and has completely different ancestry from bash.

Renaming a file using bash or zsh

mv oldname.txt newname.txt

Renaming a file using PowerShell

Move-Item oldname.txt newname.txt

For that reason, after finishing this setup assignment, use the Git Bash application to use the bash shell for the rest of the course if you are running on windows. Or alternatively, you can explore emulating linux directly on your windows machine through Windows Subsystem for Linux.

Git​

Git Version Control Software for keeping track of changes to code.

verify by running the following command in terminal or powershell:

git --version #output: git version 2.39.3

GitHub CLI​

We will use the GitHub command line interface to interact with GitHub from the terminal.

Install

choco install gh

Verify Installation Don't worry if the version is not exactly the same.

gh --version #output: gh version 2.41.0

After installing the github cli, you will need to authenticate your github account with the cli. Run the following command in your terminal or powershell and select the option to authenticate with a browser:

gh auth login

Then select select Github.com, HTTPS, Yes, Login with a web browser, and copy the one-time code and paste it in the browser popup.

 ? What account do you want to log into? GitHub.com
 ? What is your preferred protocol for Git operations? HTTPS
 ? Authenticate Git with your GitHub credentials? Yes
 ? How would you like to authenticate GitHub CLI? Login with a web browser
 ! First copy your one-time code: F485-11B8
 Press Enter to open github.com in your browser...

Verify that you have successfully authenticated by running the following command:

gh auth status

Your output should look something like this:

github.com
    ✓ Logged in to github.com as aidansunbury (/Users/aidan/.config/gh/hosts.yml)
    ✓ Git operations for github.com configured to use https protocol.
    ✓ Token: gho\_****************\*\*\*\*****************
    ✓ Token scopes: gist, read:org, repo, workflow

Finally, configure git to use the add your correct name and email address to all of your commits.

git config --global user.name "Your Name"
git config --global user.email "your-email@gmail.com"

NodeJS​

NodeJS allows you to run JavaScript/TypeScript code outside of the browser.

Install

choco install nodejs --version="22.4.1"

Verify Installation Don't worry if the version is not exactly the same.

node -v #output: v22.4.1
npm -v #output: 10.8.1

Bun​

Bun is a package manager and alternative runtime to nodejs. We will use it primarily because it has built in support for running typescript files, and because it has quicker package install times than alternatives like npm, yarn, and pnpm.

Install

powershell -c "irm bun.sh/install.ps1 | iex"

Verify Installation Don't worry if the version is not exactly the same.

bun -v #output: 1.1.8

Docker and Docker Desktop​

Docker allows you to reliably reproduce the environment an application runs in on any hardware that can run the docker engine. Docker Desktop provides a GUI for interacting with docker containers running locally on your machine.

Follow the install instructions for MacOS or Windows to install Docker Desktop. Installing the desktop application will also install the underlying docker engine.

Verify your installation with this command.

docker -v  #Docker version 25.0.3, build 4debf41

Useful VS Code Extensions​

Install the recommended vscode extensions for the course. You can disable them later if you like, but give them a try! For more information, check out our reasoning for including each one.

That's it!​

You are now ready to get started on our first lecture. If you have any questions about setup, ask them in the discord server so that other students can see our answers.