georgebigg/starter-jpa00

STARTER-jpa00

Starter code for jpa00

Assignment Description: https://ucsb-cs156.github.io/s24/lab/jpa00

This lab is a simple `"Hello, World!" type assignment to familiarize you with compiling Java using Maven, and submitting using Gradescope.

Explanation of files

Top level

• README.md It is considered good practice to document every git repo with a file called README.md. The .md extension refers to MarkDown, which is a format that allows you to create nice looking documents working from plain text. The source code is human readable, and when formatted, it looks even nicer. The text you are reading right now is written in Markdown in the README.md file.

• pom.xml This file is similar to a Makefile when working with C/C++ programming. This file works with a piece of software called Maven.

  For more information, see the links below where both Maven, and the specific pom.xml in this project are explained in more detail.

  • Maven, in general
  • The pom.xml file for this project

• The mvnw and mvnw.cmd (along with the hidden subdirectory `.mvn) are collectively referred to as the maven wrapper. They provide a way for Java programs to use the Maven utility without having to install it.

  Anywhere in the instructions you see mvn followed by a command, if you don't have the mvn command on your system (i.e. you get the error mvn: command not found) you can use ./mvnw in place of mvn (or on Windows, mvnw.cmd). More information can be found here: https://www.baeldung.com/maven-wrapper

• src This directory contains the source code for this project.

  All Maven projects must have a src directory at the top level.

• src/main/java This directory is the directory where all Java code for a Maven project (other than test code) is expected to live.

  Once we introduce packages, we'll also see levels of directories under src/main/java that correspond to the package structure, but for simple projects without packages, we put our code directly here.

• src/main/java/Hello.java This is the source file where our "Hello, World!" program can be found.

Hidden Files

If you use ls -a on this directory, you should the following hidden files:

• .mvn This is the maven wrapper subdirectory (see above).

• .git This is the subdirectory in which the git repository keeps a a record of all the various versions of the files in the repo, as well as metadata about the files in the repository.

• .gitignore This file is a list of files and filename patterns that should be ignored by git. These files are ones that should not be stored in the git repository; many are generally files produced by compiling the code.

  See https://ucsb-cs156.github.io/topics/git_gitignore.html information.