System Setup

There’s a lot to set up, and it can be frustrating if things aren’t working. Setup can be a bit finicky because different computers behave in different ways. This setup procedure is fairly tedious, but luckily we only need to do it once and it’ll save us time for future project assignments.

If something doesn’t look right, come to office hours and we can work together to figure it out. You can also let us know about any problems by making a new Ed question.

The more relevant details we can get about the problem, the better. Include the setup step that’s causing trouble, a summary of the problem, as well as what you expected to see. A screenshot can also be helpful.

Git¶

Git is a version control system (VCS), a tool for tracking changes between versions of code and sharing those changes with other people. A VCS allows us to not only see changes from old code, but also revert back to older versions and manage many different team members contributing to a project at the same time. Every student in this course gets their personal repository (repo), in which all code and its history are stored.

You may have heard of GitHub before. GitHub is an online platform for storing and managing backups of our Git repositories.

In this course, we will be using CSE GitLab, a CSE-supported alternative to GitHub. Keeping your repo backed up on CSE GitLab not only makes it convenient to find past versions of your work in case your computer crashes, but it also simplifies the process for turning in projects and allows you to collaborate with others.

SSH Keys¶

You will need to generate SSH keys to use the CSE GitLab. SSH keys fill the same role as a username and password, but they are very long and randomly generated. Many programming tools prefer to use SSH keys because they are extremely difficult to be guessed or broken.

Since SSH keys are very long, we don’t actually type in SSH keys with a keyboard. Instead, Git can automatically send it to a service when you need to authenticate. When all setup, authenticating with SSH keys are usually faster than using a username and password because you don’t need to enter the details every time.

Generate a New SSH Key Pair¶

If you already have an SSH key pair, you can use that if you prefer. Otherwise, here are the steps:

1. Open a terminal on Linux or macOS, or Git Bash on Windows (which comes with the Git installation).
2. Generate a new SSH key pair:

   ssh-keygen -t rsa
   

3. Next, you will be prompted to input a file path for your SSH key pair. Accept the defaults by pressing Enter on your keyboard. You can optionally choose a passphrase, but it is not required (especially if you are using a personal computer).
   • If you are prompted that a key already exists, it means you already have a key. You can type n-Enter to exit and go to the next section.

Add the SSH Key to Your GitLab Account¶

1. Copy your public SSH key (from your home directory, .ssh/id_rsa.pub). You can view the contents of a file from the terminal:

   cat ~/.ssh/id_rsa.pub
   

2. Visit the CSE GitLab SSH keys settings page.
3. Paste your copied public key into the Key field. Give it a title if it doesn’t have one already. Then, tap Add key.

IntelliJ¶

IntelliJ is the IDE (integrated development environment) that we’ll be using in this course. If you’ve used jGRASP before, IntelliJ is its real-world, production-ready equivalent.

Download IntelliJ¶

1. Download and install IntelliJ Community Edition. Make sure NOT to accidentally install the Ultimate edition if you haven’t signed up for an educational license.

   Open IntelliJ after installation is finished.

   

2. During the first startup, IntelliJ will ask you to configure some editor settings. You can Skip Remaining and Set Defaults, or choose a color scheme and continue.

3. After the initial setup steps are complete, you’ll be greeted by the welcome window. In the “Welcome to IntelliJ IDEA” window, tap the Plugins item in the navigation pane on the left.

   

4. From the “Plugins” screen, we’ll install two plugins:

   • Checkstyle-IDEA. A plugin that spots style errors and common bugs.
   • jGRASP. A data structures visualizer, by the same team that made the IDE.

   

   (Make sure you’re on the Marketplace tab and not the Installed tab when searching for plugins to install.)

5. After installing the plugins, you may be asked to restart IntelliJ. Heed its advice.

Get Your Repository¶

Now that the initial IntelliJ setup is done, we can download a copy of the code by cloning your personal CSE GitLab repository.

1. Let’s make sure that you have access to your personal repository.

   Visit GitLab, and you’ll be greeted by a repository named after your UWNetID. This named repository is your personal repository. Your personal repository should already have some files and folders inside including the skeleton code for the first project assignment, cse143review.

2. Then, Tap the blue Clone button and copy the Clone with SSH Git address. It should look like this:

   git@gitlab.cs.washington.edu:cse373-21sp-students/YOURUWNETID.git
   

   

3. In the IntelliJ welcome window, tap on the Get from VCS. Paste the Git address from earlier and choose a directory to store your personal repository.

4. Once IntelliJ finishes cloning your repository, a new window will ask if “Trust and Open Gradle Project.” Click Trust Project to continue.
5. Afterwards, the main IDE window will open, and IntelliJ will start importing the Gradle project; this process may take a few minutes to complete, and not all IDE functions will work properly until it does. You may need to wait for the progress bar on the bottom-right of the screen to finish before moving on to the next step.

Install Java JDK 14¶

We use Java JDK 14 for project assignments; later versions of Java may also work, but the course staff may be unable to provide support for issues relating to JDKs other than 14.

First, check what version of Java IntelliJ is using for the project by opening File » Project Structure from the top menu bar. You should see a screen like this:

If your Project SDK setting already has java version “14.X.X” as in the screenshot above, that means IntelliJ is already correctly using JDK 14.

Otherwise, click the dropdown to show the JDKs that IntelliJ has found on your machine.

• If you already have JDK 14 installed, and it is included in the list of options, then select it.
• If you already have JDK 14 installed, but it does not show up in the dropdown options, then you will need to manually add it by clicking Add SDK » JDK… and selecting your JDK 14 installation folder.
• If you do not have JDK 14 installed, or you can’t find its installation folder, click ADD SDK » Download JDK. In the new window that opens, set Version to 14, then click Download. (If you want, you can first choose another vendor that has JDK 14 or another location to install the JDK to.)

Also make sure that Project language level is set to 14.

Configure Checkstyle¶

In this course, there are no manually graded style points. Instead, you will get full credit on code style as long as you fix all Checkstyle warnings. We’ll need to set up the Checkstyle plugin with CSE 373-specific settings.

1. Open the Settings dialog (On macOS IntelliJ IDEA » Preferences, otherwise File » Settings).
2. Navigate to Tools » Checkstyle.
3. Make sure the Checkstyle version selected is 8.36.2 or greater.
4. Change the Scan Scope dropdown in the top right to Only Java sources (including tests).

5. Add the CSE 373 checkstyle configuration. Tap the + icon on the right side under Configuration File section. In the window that appears, enter a description like “CSE 373 Checks”. Then, make sure select Use a local Checkstyle file is selected and paste in the following path:

   config/checkstyle/checkstyle.xml
   

   (Enable Store relative to project location if you plan to ever move or rename the project directory; otherwise, it doesn’t matter whether this is enabled or not.)

6. Back in the Checkstyle settings, mark the checkbox next to “CSE 373 Checks” (or whatever name you chose) to enable it. This would also be a good time to hit Apply.

Configure Generics Checks¶

Finally, we’ll configure IntelliJ to prevent you from making a common generics-related issue. With the Settings window still open:

1. Navigate to Editor » Inspections.
2. Open the Java » Java language level migration aids » Java 5 section.
3. Enable Raw use of parameterized class. If it’s already enabled, click its row to reveal more options.
4. Change Severity to Error, and change the other Options below to match this image:

Now, you can click OK to save and apply the settings.

Phew, that’s it! What’s next?

Follow the Using IntelliJ quick start guide to introduce yourself to the software we’ve just installed.