Skip to content

A2-Byrnezy-Brendan-Byrne #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Byrnezy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

A2-Byrnezy-Brendan-Byrne #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 14 additions & 95 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,100 +1,19 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===

Due: September 9th, by 11:59 AM.

This assignment will introduce you to creating a prototype two-tiered web application.
Your application will include the use of HTML, CSS, JavaScript, and Node.js functionality, with active communication between the client and the server.

Baseline Requirements
---

There are a range of application areas and possibilities that meet these baseline requirements.
Try to make your application do something useful! A todo list, storing / retrieving high scores for a very simple game... have a little fun with it.

Your application is required to implement the following functionalities:

- a `Server` which not only serves files, but also maintains a tabular dataset with 3 or more fields related to your application
- a `Results` functionality which shows the entire dataset residing in the server's memory
- a `Form/Entry` functionality which allows a user to add or delete data items residing in the server's memory
- a `Server Logic` which, upon receiving new or modified "incoming" data, includes and uses a function that adds at least one additional derived field to this incoming data before integrating it with the existing dataset
- the `Derived field` for a new row of data must be computed based on fields already existing in the row.
For example, a `todo` dataset with `task`, `priority`, and `creation_date` may generate a new field `deadline` by looking at `creation_date` and `priority`

Your application is required to demonstrate the use of the following concepts:

HTML:
- One or more [HTML Forms](https://developer.mozilla.org/en-US/docs/Learn/HTML/Forms), with any combination of form tags appropriate for the user input portion of the application
- A results page displaying all data currently available on the server. You will most likely use a `<table>` tag for this, but `<ul>` or `<ol>` could also work and might be simpler to work with. Alternatively, you can create a single-page app (see Technical Acheivements) but this is not a requirement.
- All pages should [validate](https://validator.w3.org)
- If your app contains multple pages, they should all be accessible from the homepage (index.html)

CSS:
- CSS styling of the primary visual elements in the application
- Various CSS Selector functionality must be demonstrated:
- Element selectors
- ID selectors
- Class selectors
- CSS positioning and styling of the primary visual elements in the application:
- Use of either a CSS grid or flexbox for layout
- Rules defining fonts for all text used; be deliberate! Be sure to use a web safe font or a font from a web service like [Google Fonts](http://fonts.google.com/)

- CSS defined in a maintainable, readable form, in external stylesheets

JavaScript:
- At minimum, a small amount of front-end JavaScript to get / fetch data from the server; a sample is provided in this repository.

Node.js:
- An HTTP Server that delivers all necessary files and data for the application, and also creates the required `Derived Fields` in your data.
A starting point is provided in this repository.

Deliverables
---

Do the following to complete this assignment and acheive a base grade of 85%:

1. Fork the starting project code. This repo contains some starter code that may be used or discarded as needed.
2. Implement your project with the above requirements.
3. Test your project to make sure that when someone goes to your main page, it displays correctly.
4. Deploy your project to Glitch, and fill in the appropriate fields in your package.json file.
5. Ensure that your project has the proper naming scheme `a2-yourGithubUsername` so we can find it.
6. Modify the README to the specifications below, and delete all of the instructions originally found in this README.
7. Create and submit a Pull Request to the original repo. Label the pull request as follows: a2-gitusername-firstname-lastname

Acheivements
---

Below are suggested technical and design achievements. You can use these to help boost your grade up to an A and customize the assignment to your personal interests. These are recommended acheivements, but feel free to create/implement your own... just make sure you thoroughly describe what you did in your README and why it was challenging. ALL ACHIEVEMENTS MUST BE DESCRIBED IN YOUR README IN ORDER TO GET CREDIT FOR THEM. Remember, the highest grade you can get on any individual assignment is a 100%.

*Technical*
- (5 points) Create a single-page app that both provides a form for users to submit data and always shows the current state of the server-side data. To put it another way, when the user submits data, the server should respond sending back the updated data (including the derived field calculated on the server) and the client should then update its data display.

- (5 points) In addition to a form enabling adding and deleting data on the server, also add the ability to modify existing data.

*Design/UX*
- (5 points per person, with a max of 10 points) Test your user interface with other students in the class. Define a specific task for them to complete (ideally something short that takes <10 minutes), and then use the [think-aloud protocol](https://en.wikipedia.org/wiki/Think_aloud_protocol) to obtain feedback on your design (talk-aloud is also fine). Important considerations when designing your study:

1. Make sure you start the study by clearly stating the task that you expect your user to accomplish.
2. You shouldn't provide any verbal instructions on how to use your interface / accomplish the task you give them. Make sure that your interface is clear enough that users can figure it out without any instruction, or provide text instructions from within the interface itself.
3. If users get stuck to the point where they give up, you can then provde instruction so that the study can continue, but make sure to discuss this in your README. You won't lose any points for this... all feedback is good feedback!

You'll need to use sometype of collaborative software that will enable you both to see the test subject's screen and listen to their voice as they describe their thoughts, or conduct the studies in person. After completing each study, briefly (one to two sentences for each question) address the following in your README:

1. Provide the last name of each student you conduct the evaluation with.
2. What problems did the user have with your design?
3. What comments did they make that surprised you?
4. What would you change about the interface based on their feedback?

*You do not need to actually make changes based on their feedback*. This acheivement is designed to help gain experience testing user interfaces. If you run two user studies, you should answer two sets of questions.

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---
Glitch Link: https://a2-byrnezy.glitch.me/

## Your Web Application Title
Include a very brief summary of your project here. Be sure to include the CSS positioning technique you used, and any required instructions to use your application.
This project is a Car Tracker web app. In this app the user can add, view, and delete, while also able to view the cars Model, Year, MPG, and Years Old based on its year. The app uses CSS Flexbox for positioning a responsive and clean layout. The server calculates the derived field (Years Old) dynamically.

### Instructions to Use:
1. Enter car details (Model, Year, MPG) into the form.
2. Submit the form to add the car to the table.
3. Click "Remove" in the Actions column to delete a car from the list.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **Tech Achievement 1**: Whenever data is submitted or deleted the displayed list shows the most up to date contents in the list.

- **Tech Achievement 2**:
1. In the table, click the "Edit" button next to the car you want to modify.
2. Modify the car details in the form.
3. After making the changes, click the Submit Edit button.
4. The table will refresh with the updated car data.

### Design/Evaluation Achievements
- **Design Achievement 1**:
35 changes: 33 additions & 2 deletions public/css/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,35 @@
body {
background:black;
color:white;
font-family: Arial, sans-serif;
margin: 20px;
}

h1, h2 {
text-align: center;
}

form {
display: flex;
flex-direction: column;
align-items: center;
margin-bottom: 20px;
}

form label {
margin-right: 10px;
}

table {
width: 100%;
border-collapse: collapse;
margin-top: 20px;
}

th, td {
border: 1px solid black;
padding: 10px;
text-align: center;
}

th {
background-color: #50ee80;
}
28 changes: 19 additions & 9 deletions public/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
<!doctype html>
<html lang="en">
<head>
<title>CS4241 Assignment 2</title>
<title>Car Tracker</title>
<meta charset="utf-8">
<script src="js/main.js"></script>
<link rel="stylesheet" href="css/main.css">

<!-- get rid of favicon error -->
<link rel="icon" href="data:;base64,iVBORw0KGgo=">
</head>
<body>
<form>
<input type="text" id="yourname" value="your name here">
<button>submit</button>
<body class="center">
<h1 class="center">Car Tracker</h1>
<p>Add a car to the list:</p>
<form id="car-form" method="POST">
<input type="text" id="model" placeholder="Car Model" required>
<input type="number" id="year" placeholder="Year" required>
<input type="number" id="mpg" placeholder="MPG" required>
<button type="submit">Submit</button>
</form>
<table id="car-table">
<tr>
<th>Model</th>
<th>Year</th>
<th>MPG</th>
<th>Years Old</th>
<th>Actions</th>
</tr>
</table>
</body>
</html>
</html>
121 changes: 100 additions & 21 deletions public/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,106 @@
// FRONT-END (CLIENT) JAVASCRIPT HERE

const submit = async function( event ) {
// stop form submission from trying to load
// a new .html page for displaying results...
// this was the original browser behavior and still
// remains to this day
event.preventDefault()
let appdata = [];
const submitCar = async function(event) {
event.preventDefault();

const model = document.querySelector("#model").value.trim();
const year = parseInt(document.querySelector("#year").value);
const mpg = parseInt(document.querySelector("#mpg").value);

const input = document.querySelector( '#yourname' ),
json = { yourname: input.value },
body = JSON.stringify( json )
console.log("Car Data:", { model, year, mpg });

if (!model || isNaN(year) || isNaN(mpg)) {
window.alert("Please fill in all fields correctly");
return;
}

const cardata = { model, year, mpg };

const response = await fetch( '/submit', {
method:'POST',
body
})
try {
const response = await fetch('/submit', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(cardata)
});
const data = await response.json();
updateCarTable(data);
} catch (error) {
console.error('Error:', error);
}
};

const text = await response.text()
const editCar = function(index) {
const car = appdata[index];

console.log( 'text:', text )
}
document.querySelector("#model").value = car.model;
document.querySelector("#year").value = car.year;
document.querySelector("#mpg").value = car.mpg;
};

const removeCar = async function(index) {
try {
const response = await fetch(`/delete/${index}`, {
method: 'DELETE',
});
const data = await response.json();
updateCarTable(data);
} catch (error) {
console.error('Error:', error);
}
};

const submitEdit = async function(index) {
removeCar(index);
const model = document.querySelector("#model").value.trim();
const year = parseInt(document.querySelector("#year").value);
const mpg = parseInt(document.querySelector("#mpg").value);

console.log("Car Data:", { model, year, mpg });

if (!model || isNaN(year) || isNaN(mpg)) {
window.alert("Please fill in all fields correctly");
return;
}

const cardata = { model, year, mpg };
try{
const response = await fetch('/submit', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(cardata)
});
} catch (error) {
console.error('Error:', error);
}
};

const updateCarTable = function(data) {
appdata = data;
const table = document.querySelector("#car-table");
table.innerHTML = "<tr><th>Model</th><th>Year</th><th>MPG</th><th>Years Old</th><th>Actions</th></tr>";

data.forEach((car, index) => {
const row = `
<tr>
<td>${car.model}</td>
<td>${car.year}</td>
<td>${car.mpg}</td>
<td>${car.yearsOld}</td>
<td>
<button onclick="editCar(${index})">Edit</button>
<button onclick="submitEdit(${index})">Submit Edit</button>
<button onclick="removeCar('${index}')">Remove</button>
</td>
</tr>
`;
table.innerHTML += row;
});
};

window.onload = function() {
const button = document.querySelector("button");
button.onclick = submit;
}
document.querySelector("#car-form").addEventListener("submit", submitCar);

fetch('/data', { method: 'GET' })
.then(response => response.json())
.then(data => updateCarTable(data))
.catch(error => console.error('Error:', error));
};
Loading