Portfolio 4 Mechanics

Some notes on the mechanics for Portfolio 4…

Repositories

Each group should create one repository using the link at: https://classroom.github.com/a/wvAjgmyv - this will make an empty repository (advice on how to fill it below).

One one member of the group has created a repository, send a message to the TA who will add write access to the repository.

Progress Reports

Each student will need to do a progress report. If you are working in a group, each person should do the progress report independently (this is to check that all members of the group have a consistent view of what they group is doing, and to see the planned individual contributions).

The progress report form is: Portfolio 4 Progress Report (due Thu, Apr 24).

Please do your progress report on time. I’d prefer to get an ontime report (with less results) than a late report.

Workbook Format

Your goal is to create something in a “workbook format” - a small, self-contained, website (in a Git Repository). There needs to be an index.html that page should have basic info on it (your name, a description of the project, etc.). That page should guide the reader to other pages/content. (or you could put everything on one page, but that isn’t recommended).

Your index.html can either be in the root directory of the repository or it can be generated using the Hugo static website generator. If you use Hugo, you will turn in a hugo site (do not include the generated web pages).

If you choose to the Hugo route… there will be some learning curve as you will need to figure out how to use a static website generator. We will provide you with the workbook style sheet we use for class, and can give you a little support. Learning Hugo is a good thing (I find it a really useful tool), but it is tangential to learning graphics. For the portfolio, it is unlikely that you will save time using Hugo (over creating the HTML by hand). But it is a useful skill. If you want to go this route, talk to the professor:

If you are not using Hugo, index.html should be in the root of the directory.

Other than that, we leave it to the student to decide how to put the content onto web pages. If you like the way we have made workbooks, we will give you a “blank workbook” (similar to what we did for Portfolio 1).

The Starter Code

You can start with your empty repo and create everything yourself. You will probably want to copy over the “libs” directory from Portfolio 3 (or some other later workbook).

We have created a “blank workbook” (similar to Portfolio 1) that has 5 empty pages (well, they have a simple example program to show how to put a program on the page).

To merge this into your repository… On you local machine, clone your personal repository, go into that directory, and do these 4 commands:

git remote add empty git@github.com:CS559-Spring25-AH/Portfolio4-EmptyShell.git
git fetch empty
git merge empty/main
git push -u origin main

What this does: first it connects a second “remote” called “empty” to my repository; it gets a copy of the repository; it merges my version into yours, and then it pushes it to your remote repository (that should be origin).