If you don't already have it, install git.
If you're on macOS, we recommend installing the full developer tools suite by running
in the terminal.
If you're on Windows, we recommend running the installer from the git homepage. This will also install Git Bash, which is a great first Unix-like command line to learn if you are a Windows user and are not already using something more advanced like WSL.
Install Java 11 if you don't have it already. A good place to get it is AdoptOpenJDK. Choose the OpenJDK 11 (LTS) and HotSpot JVM options, and then download. MacOS and Linux users can just run the installers directly using the default options. Windows users should run the installers and additionally make sure "Repair Registry" and "Set JAVA_HOME" are checked when prompted. We generally suggest that Windows users uninstall all previous versions of Java (JDK or JRE) before installing the current version to reduce the chances that IntelliJ or other tools will pick the wrong version by accident.
To verify your installation, open a terminal (the Terminal app on macOS, or Git Bash/Command Prompt/Powershell/WSL on Windows) and run the command
A message should be printed indicating version 11 is installed. If you get an older version or have trouble, try uninstalling older versions of Java you may have installed, or contact the course staff for more help.
Run the installer for your OS from the IntelliJ homepage.
If you already have IntelliJ installed, be sure to update to at least version 2021.1 so that you have Lombok support.
Open IntelliJ and click through the initial setup steps. You do not need anything more than the default plugins and configuration for this course. At the splash screen, click "Configure" at the bottom-right and open "Preferences." Navigate to Version Control > Git and click the "Test" button at the top right. This test should succeed and report a git version. If you have any trouble with this, contact the course staff for help.
You always edit your own personal copy of files that are under git control. Before you can make such edits, you must "clone" to create your local repository. You need to do this step only once at the beginning of the term.
Ensure that your repository exists, by browsing to
NETIDis your netid). If the repository does not exist, contact course staff.
If you do not already have one, set up an ssh key as follows
Open a terminal and run the following command, replacing "firstname.lastname@example.org" with any identifying text (this is just 'comment' text). Do not remove the quotations.
ssh-keygen -o -t rsa -b 4096 -C "email@example.com"
~/.ssh/id_rsa.pub, but use whatever is listed from your command. It will end with
For example, if your file was saved as
cat [public key file name here] | clip # Windows cat [public key file name here] # (macOS/Linux)
id_rsa.pub, then on macOS/Linux the command would be:
For Windows users, the above command automatically copies the data. On macOS/Linux, you will need select with the mouse and copy it.
If you get stuck, also check these instructions from Gitlab.
ssh -T firstname.lastname@example.org
Now that you have an SSH key, you are ready to clone the repository. You can clone from inside IntelliJ or on the command line.
(Occasionally, Windows users have had trouble cloning their repository within IntelliJ. These Windows users had success cloning their repository from the command line using the "git bash" tool, then doing all their work within IntelliJ after the initial clone step. Please try that if you have trouble, and contact course staff if you are still stuck.)
Open IntelliJ. On the splash screen, choose "Get from Version Control". Select "Git" under Version Control, and choose a convenient place on your computer for "Directory"—this is where you'll be storing your work for the rest of the quarter. For URL, use the text below. Be sure to replace "NETID" with your netid.
After the project opens, you need to close it and repoen the
java/ subfolder as the project root.
To do this, click File > Close Project. And then File > Open, and navigate to wherever you cloned the project,
and then double click the
java/, and finall click the open button. You should be able to click the build
button and see no errors. Contact course staff if you get stuck.
First, decide where you want to clone the repository. If you are not sure, one easy place to find later is to use your home directory,
which is abbreviated by the tilde character
Then run the following command to clone the repository, being sure to replace "DESIRED_DIRECTORY" with the path to wherever you decided to clone your work (or just "~" to use your home directory), and also replace "NETID" with your netid.
cd DESIRED_DIRECTORY git clone email@example.com:cse341-22sp/cse341-22sp-NETID.git
The easiest way is to first install the Homebrew package manager. After installing Homebrew, close the terminal and reopen it before proceeding. Then run
brew install ocaml brew install opam
Then install the command-line developer tools if you haven't already. After that, install the necessary opam packages.
xcode-select --install opam install dune utop ocaml-lsp-server ppx_inline_test ppx_deriving
Unfortunately OCaml support on Windows is quite bad. If you are willing to try the Windows Subsystem for Linux (WSL), which allows you simulate a Linux environment from inside Windows, that may be your best bet. After installing WSL, you can follow the instructions for Ubuntu Linux below.
An alternative approach is to install OCaml for Windows.
Use the 64-bit graphical installer.
After installation, make sure
ocaml-env is accessible on the PATH.
From inside the installed custom cygwin environment, run
Then, to use this from inside VS Code, check out this Stack Overflow answer which describes how to add a new terminal type to VS Code. Set the terminal path to
opam install dune utop ocaml-lsp-server ppx_inline_test ppx_deriving
"C:\\OCaml64\\bin\\bash.exe". Also add the setting
If you are a Windows user who succeeded in getting OCaml setup, we would love to hear from you so that we can improve these notes. Please contact course staff.
apt install build-essential ocaml add-apt-repository ppa:avsm/ppa apt update apt install opam opam install dune utop ocaml-lsp-server ppx_inline_test ppx_deriving
You can also run OCaml on attu, but you will need to upgrade its version of OCaml to a later version.
opam is already installed globally, but you will need to initialize it for your username
It will ask you a question about modifying
yto say yes.
This will take several minutes.
opam switch create 4.12.1
Log out and log back in to reload your shell configuration. Then run
and confirm that it reports version
If you still see the wrong version, it's possible that your shell is not correctly configured. Some students were able to work around their broken shell configuration by running the command.
eval $(opam env --switch=4.12.1)
to install the course dependencies.
opam install dune utop ocaml-lsp-server ppx_inline_test ppx_deriving
Follow the instructions on the VS Code homepage.
Once open, install the "OCaml Platform" extension (not the "OCaml and Reason" extension).
Git is famous for being difficult to use and easy to screw up. If you get stuck, please ask for help!
Go to View > Tool Windows > Commit. This should open a small window on the left side of the editor. Find all the files you changed or added and check the checkbox next to them. Write a little message in the text box below and press "Commit and Push". That's it! For more information, see the IntelliJ documentation.
Go to View > SCM. This should open a small window on the left side of the editor. Find all the files you changed or added and click the plus sign next to them. Write a little message in the text box at the top of the window and press Control-Enter (Command-Enter on macOS) to commit.
To push, click the tiny 3 dots icon in the upper right corner of the small Git window, and select "Push". That's it! For more information, see the VS Code documentation.
For each file that you changed, and for each new file that you want to add, run
git add FILE
FILE is the name of the file.
To make sure you are about to commit what you intend, you can run
To make a commit, run
git commit -m "my commit message" replacing the message between quotes
with a short descriptive message about your changes (don't delete the quotes).
To push your changes to gitlab, run
We are using Gradescope to manage grading and submissions this quarter. Go to Gradescope and click "Upload submission" for the assignment you are trying to submit. You should see a window like this:
Click the Gitlab button. Then you will see a window like this:
If you have many repositories on CSE gitlab, use the search bar at the top to search for
Ensure the main branch is selected. (Or, if you are using git branches to organize your work, select the correct branch.)