cs302-S2019-lab2-starter

Designed for use with GitHub Classroom, this repository contains the starter for Laboratory 2 in Computer Science 302. Since the Travis builds for this repository will initially fail (as evidenced by a red ✗ appearing in the commit logs instead of a green ✔), the programmer is responsible for completing all of the steps needed to satisfy the requirements for the assignment, thus causing a ✔ to instead appear in the commit logs.

Introduction

This assignment requires a programmer to implement a static web site using the HTML programming language. Specifically, you will create a travel photography web site like the one in Figure 3.9 of the textbook. For this laboratory assignment, you will link to an image that is available from the Flickr Archive of photographs under a Creative Commons license. You will also learn how to program in HTML5 using tags. Then, you will run a web server to provide local access to the static web site, learning more about how to talk about a file system's structure. Finally, you will learn how to use the HTMLHint static analysis code tool that can check HTML files for potential errors.

The programmer is also responsible for writing a reflection, stored in the file writing/reflection.md, that responds to the questions in the assignment sheet and explains the challenges that you faced and the solutions you developed. Please note that this is also a Markdown file that must adhere to the standards described in the Markdown Syntax Guide. Remember, you can preview the contents of a comitted Markdown file by clicking on the name of the file in your GitHub repository. Finally, don't forget that your writing/reflection.md file and the file mentioned in the previous paragraph should both adhere to the Markdown standards established by the Markdown linting tool and the writing standards set by the Proselint tool.

The source code in the travels.html file must also pass additional tests set by the GatorGrader tool. For instance, GatorGrader will check to ensure that your main file contains the required header and that, for instance, it contains the correct number of time tags. GatorGrader will also check that you made the required number of commits to your repository and that your writing contains the specified number of paragraphs. More details about the GatorGrader checks are included later in this document and in the assignment sheet.

When you use the git commit command to transfer your source code to your GitHub repository, Travis CI will initialize a build of your assignment, checking to see if it meets all of the requirements. If both your source code and writing meet all of the established requirements, then you will see a green ✔ in the listing of commits in GitHub. If your submission does not meet the requirements, a red ✗ will appear instead. The instructor will reduce a programmer's grade for this assignment if the red ✗ appears on the last commit in GitHub immediately before the assignment's due date.

A carefully formatted assignment sheet for this project provides more details about the steps that a computer scientist should take to complete this assignment. You can view this assignment sheet by visiting the listing of laboratories on the course web site.

Learning

If you have not done so already, please read all of the relevant GitHub Guides that explain how to use many of the features that GitHub provides. In particular, please make sure that you have read the following GitHub guides: Mastering Markdown, Hello World, and Documenting Your Projects on GitHub. Each of these guides will help you to understand how to use both GitHub and GitHub Classroom.

To do well on this assignment, you should also review Chapters 1 through 3 of the course textbook, paying close attention to Section 3.5 and Figure 3.9. Please see the course instructor or one of the teaching assistants or tutors if you have questions about any of these reading assignments.

Commands

To get started in using the GatorGrader tool, you can change into the directory for this assignment and type the command gradle grade in your terminal. Running this command will produce a lot of output that you should carefully inspect. If the output indicates that GatorGrader judges that there are no mistakes in the assignment, then this means that your source code and writing are passing all of the automated baseline checks. However, if the output indicates that there are mistakes, then you will need to understand what they are and then try to fix them. Finally, remember that you must run the gradle grade command from the main (or "home base") directory for this assignment where the build.gradle file is located. Then, you can type the command in the terminal and study the output.

Checking

In addition to making the checks that were previously mentioned in the introduction to this document, your final submission must meet the following requirements.

• src/www/travels.html:

  • Passes the checks performed by the HTML linting tool, reporting no errors found
  • Contains exactly one use of a title tag with Share Your Travels as content
  • Contains exactly one use of an h1 tag with Share Your Travels as content
  • Contains exactly four uses of an p tag with the appropriate content
  • Contains exactly two uses of a time tag with the appropriate content
  • Contains exactly two uses of a div tag with the appropriate content
  • Contains exactly one use of an h3 tag with Reviews as content
  • Contains exactly one use of the html and head and body tags

• images/travels_submission.png:

  • The file exists in the correct directory with a screenshot of your final web site

• writing/reflection.md:

  • Passes the checks performed by the Markdown linting tool
  • Passes the checks performed by the Prose linting tool
  • Contains exactly one contiguous paragraph of formatted text
  • The contiguous paragraph contains at least 100 words

• GitHub repository:

  • Contains five commits beyond the repository's starting number of commits

Updates

If the course instructor updates the provided material for this assignment and you would like to receive these updates, then you can type this command in the main directory for this assignment:

git remote add download git@github.com:Allegheny-Computer-Science-302-S2019/cs302-S2019-lab1-starter.git

You should only need to type this command once; typing the command additional times may yield an error message but will not negatively influence the state of your repository. Now, you are ready to download the updates provided by the course instructor by typing:

git pull download master

This second command can be run whenever the course instructor needs to provide you with new source code for this assignment. However, please note that, if you have edited the files that the course instructor updated, running the previous command may lead to Git merge conflicts. If this happens, you may need to manually resolve them with the help of the instructor or a teaching assistant.

Travis

This assignment uses Travis CI to automatically run the checking programs every time you commit to your GitHub repository. The checking will start as soon as you have accepted the assignment, thus creating your own private repository, and the course instructor enables Travis for it. If you are using Travis for the first time, you will need to authorize Travis CI to access the private repositories that you created on GitHub.

Requirements

The GatorGrader software that supports the checking of this assignment was developed for the following software and versions:

• Gradle 4.6
• Java 1.8.0
• MDL 0.4.0
• Proselint 0.8.0
• Python 3.6

Problems

If you have found a problem with this assignment's provided source code, then you can go to the Computer Science 302 Lab 2 Starter repository and create an issue by clicking the "Issues" tab and then clicking the green "New Issue" button. If you have found a problem with the GatorGrader tool and the way that it checks you assignment, then you can follow the aforementioned steps to create an issue in its repository. To ensure that your issue is properly resolved, please provide as many details as is possible about the problem that you experienced. If you discover a problem with the laboratory assignment sheet, then please raise an issue in the cs302-S2019-sheets repository and mention this assignment.

Students who find, and use the appropriate GitHub issue tracker to correctly document, a mistake in any aspect of this laboratory assignment will receive free laptop stickers and extra credit towards their grade for it.

Assistance

If you are having trouble completing any part of this project, then please talk with either the course instructor or a teaching assistant during the laboratory session. Alternatively, you may ask questions in the Slack team for this course. Finally, you can schedule a meeting during the course instructor's office hours.