Assignment Requirements
This page lists the example project requirements for Example 11 in CC 410. Read the requirements carefully and discuss any questions with the instructors or TAs.
Purpose
This example will cover updating an existing project to include a lightweight web framework and generate dynamic web pages.
General Requirements
- All code must be object-oriented.
- All executable code must be within a class
- Python package files such as
__init__.py and __main__.py are exempt.
- Classes must be organized into packages based on common usage.
- This project must include automation for compilation and execution.
- Java: Use Gradle with the
application and jacoco plugins. The project should compile without errors.
- Python: Use tox configured to use Python 3.10 and a requirements file to install libraries.
- All code must properly compile or be interpreted.
- Java: It must compile using Gradle.
- Python: It must be interpreted using Python 3.10. Where specified, type hints should be included in the code, and all code should pass a strict Mypy type check.
- There are instances where Mypy is unable to determine the type of lambda expressions used as commands with buttons. This error can be ignored.
- Unit tests are not required.
- Documentation comments are not required for this example, but they are recommended for your own use.
- All code submitted must be free of style errors. We will be using the Google Style Guide for each language.
- Style errors related to documentation comments (or lack thereof) will be ignored.
- Java: Use Checkstyle 10.6.0+ and the Google Style Configuration.
- You may modify the configuration to allow 4 space indentations instead of 2 space indentations.
- Python: Use Flake8 with the
flake8-docstrings and pep8-naming plugins. Code should conform to PEP 8 style with Google style docstrings.
- All HTML must conform to the HTML5 standard. Use the W3C Validator to check your rendered pages if desired.
- Submissions to Canvas should be tagged GitHub releases that are numbered according to Semantic Versioning.
Assignment Requirements
This milestone should include the following new GUI features:
- Install a Web Framework into the project
- Java - Install the Spring framework using the Spring Initializr. It should include the Spring Boot DevTools, Spring Web, and Thymeleaf Template Engine as dependencies.
- Python - Install the Flask framework and the Flask-Classful extension. You may also wish to install
python-dotenv to use a .flaskenv file.
- Create a
movies.web package.
- Create a new
Web class in the movies package that will launch the website. Configure the project to use this class as the main class.
- Create a
MoviesController class in the movies.web package that will handle the following pages:
/ - a static index page that will list all of the movies in the database/about/ - a static about page. You will create this part on your own!/greeting/ - a “Hello World” greeting/greeting/name/ - a “Hello name” greeting
- Each page should be rendered using an appropriate template that uses/inherits from a standard base template.
- The base template should include an appropriate website title, navigation, body, and a footer.
Time Requirements
Completing this project is estimated to require 1-2 hours.
Grading Rubric
This assignment will be graded based on the rubric below:
- Install Web Framework - 10%
Web Class - 10%Controller Class - 10%- Base Layout - 10%
- Index Page - 30%
- About Page - 20%
- Greeting Page - 10%
The following deductions apply:
- Any portion of the project which will not compile (Java), pass a strict type check (Python), or execute properly will be given a grade of 0.
This is not an exhaustive list of possible deductions. The instructors will strive to provide reasonable and fair grading, but we can’t predict all possible defects. It is up to the student to ensure that the project is complete and correct before submission.
Submission
Submit this assignment by creating a release on GitHub and uploading the release URL to the assignment on Canvas. You should not submit this Codio project or mark it as complete in Codio, in case you need to come back to it and make changes later.
Java
YouTube Video
Outline
Here is a basic outline of the steps to follow to complete this example.
- Clone Starter Code from GitHub
- Install SDKMAN
Instructions
curl -s "https://get.sdkman.io" | bash
-
Close and Reopen Terminal to load SDK Man
-
Install Gradle
- Compile, Run & Test Existing Project
cd java
gradle run
gradle check
-
Confirm that project runs and has no style errors.
-
Follow along with the video to create the project.
-
Add the about page yourself!
-
When complete, use Git to commit and push updated code.
git add .
git commit -m "Example Complete"
git push
- On GitHub, create a release tag and submit URL to Canvas for grading.
When using Spring Initializr, below is a screenshot showing what it should look like.
The generated build.gradle file looks like this as of Spring 2021:
plugins {
id 'org.springframework.boot' version '2.4.4'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'web'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
developmentOnly 'org.springframework.boot:spring-boot-devtools'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
test {
useJUnitPlatform()
}