Skip to content
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.

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

a2-ezrabarb #80

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.DS_Store
node_modules/
package-lock.json
3 changes: 3 additions & 0 deletions .glitch-assets
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{"name":"showpic.png","date":"2019-09-08T19:25:11.108Z","url":"https://www.514blog.ca/wp-content/uploads/2020/03/1_dBJMknulIZSAC36tTmanVA.jpeg","type":"image/png","size":29741,"imageWidth":320,"imageHeight":320,"thumbnail":"https://cdn.glitch.com/4f0fe7ab-196a-4c13-9b89-b60fd2312715%2Fbookpic.png","thumbnailWidth":320,"thumbnailHeight":320,"uuid":"Kjjp8ctJmV6WIBj2"}
{"uuid":"Kjjp8ctJmV6WIBj2","deleted":true}
{"name":"showpic2.jpg","date":"2019-09-08T19:27:31.906Z","url":"https://www.514blog.ca/wp-content/uploads/2020/03/1_dBJMknulIZSAC36tTmanVA.jpeg","thumbnailWidth":330,"thumbnailHeight":207,"uuid":"LsI6dViHEIvjQBNw"}
111 changes: 21 additions & 90 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,100 +1,31 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
Assignment 2 - Short Stack
===

Ezra Barboza

Due: September 9th, by 11:59 AM.
## Show Tracker

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.
I love watching TV shows but often find myself forgetting the show recommendations that people tell me, or not being able to provide suggestions on the spot.
This project is an organizational tool to keep track of all the shows you have watched and want to watch, showing not only the name of the shows and directors, but also a comments section and ratings. The tracker further sorts the shows into sections based on whether you liked them or not.

Baseline Requirements
---
While this is a personal organizational tool at this time, in the future I could envision it as a forum for TV show enthusiasts to share their best/worst show picks.

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.
Note: Almost all the time, clicking the buttons will automatically update the tables (I have my `loadData` function for the tables called in all of the `onclick` functions), but sometimes if the website has been sitting open for a while, you need to refresh the page if a button was pressed but the tables aren't automatically updating.

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)
---

## 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.
Link:
https://a2-ezrabarb.glitch.me/

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...
- **getElement vs. Query**: In my script, I used `getElementById` for most of the input fields, but I also tried using `querySelector` for the table body data.
I have no prior experience using either of these functionalities, so I experimented with both to learn more.
- **Variety Of Posts**: With my POST handling, I sent and handled different types of data each time. In some cases, I sent JSON and in others, merely a string with the show's name.
I was able to handle different types of POST requests, ensuring I only sent as much data as needed for each functionality.
- **Form Reset**: Every time I interacted with a form, I not only loaded the new data but also reset all the forms afterward. This resets the input fields, providing a clean slate after each submission, which is more visually appealing and confirms that the form data was successfully submitted.
- **Status**: My derived data field was `status`, which is one of two values: `good` or `bad`. The status is derived from the rating, where anything 3 or above is considered good, and below is bad. These values are used to sort the shows into `good` or `bad` tables.
I chose this method to visually show how shows are updated when their ratings change, moving them between tables when the rating changes from good to bad or vice versa.

### Design/Evaluation Achievements
- **Design Achievement 1**:
- **User Testing**: While working on this project, I had both of my roommates try the website (without any instructions from me) to ensure the flow and functionality were intuitive for users.
- **Flex**: For creating the side-by-side layout, I applied flexbox techniques based on what we learned in class.
- **Button CSS**: The buttons change color on hover, which adds a pop of color to an otherwise simple page design. I also considered contrast when selecting button colors, background colors, and text colors to ensure readability and visual appeal.
- **Tables**: I implemented a large table showing all of the data, as well as two other tables that sort shows into ones the user liked and ones they didn’t, based on the derived `status` field. These tables update as shows are edited and ratings are changed, visually representing how I like to organize my own lists of shows.
28 changes: 18 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
{
"name": "",
"version": "",
"description": "",
"author": "",
"scripts": {
"start": "node server.js"
},
"dependencies": {
"mime": "^2.4.4"
}
"name": "a2-ezrabarb",
"version": "0.1.0",
"description": "WPI CS4241 Assignment 2",
"author": "Ezra Barboza",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/yourusername/your-repo.git"
},
"scripts": {
"start": "node server.js"
},
"dependencies": {
"express": "^4.21.1"
},
"engines": {
"node": ">=14.x"
}
}
4 changes: 0 additions & 4 deletions public/css/main.css

This file was deleted.

103 changes: 103 additions & 0 deletions public/css/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
html, body {
height: 100%;
margin: 0;
font-family: 'Roboto', sans-serif;
}

body {
background: linear-gradient(135deg, #f5f7fa 0%, #c3cfe2 100%);
}

#big-title {
font-size: 40px;
font-family: 'Orbitron', monospace;
font-weight: bold;
color: #FFFAE3;
text-shadow: 2px 2px 4px rgba(0, 0, 0, 0.6);
text-align: center;
margin: 20px 0;
}

.content {
max-width: 1000px;
margin: 40px auto;
background: rgba(130, 212, 206, 0.9); /* Add transparency */
border-radius: 12px;
padding: 20px;
text-align: center;
box-shadow: 0 4px 10px rgba(0, 0, 0, 0.15);
}

legend {
font-family: 'Orbitron', monospace;
font-size: 20px;
color: #333;
}

.table-label {
font-size: 24px;
font-family: 'Orbitron', monospace;
color: #fff;
background-color: #282828;
margin-top: 10px;
padding: 8px;
border-radius: 6px;
}

.table {
font-family: 'Roboto', sans-serif;
border-collapse: collapse;
width: 100%;
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
}

table, th, td {
border: 1px solid #ddd;
padding: 10px;
}

th {
background-color: #FC7550;
color: white;
}

tbody {
text-align: left;
}

#wrapper {
display: flex;
gap: 20px; /* Add spacing between flex items */
margin: 20px 0;
}

#left-edit {
flex: 0 0 45%;
padding: 10px;
background-color: rgba(240, 240, 240, 0.7);
border-radius: 8px;
}

#right-edit {
flex: 1;
padding: 10px;
background-color: rgba(240, 240, 240, 0.7);
border-radius: 8px;
}

button {
font-family: 'Orbitron', monospace;
background-color: #fff;
color: #FC7550;
border: 2px solid #FC7550;
padding: 10px 20px;
border-radius: 8px;
cursor: pointer;
transition: all 0.3s ease;
}

button:hover {
background-color: #FC7550;
color: #fff;
transform: scale(1.05);
}
105 changes: 94 additions & 11 deletions public/index.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,101 @@
<!doctype html>
<html lang="en">
<head>
<title>CS4241 Assignment 2</title>
<title>Show 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=">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<form>
<input type="text" id="yourname" value="your name here">
<button>submit</button>
<body class="content">
<h1 class="table-label" id="big-title">
Show Tracker
</h1>
<img src ="https://www.514blog.ca/wp-content/uploads/2020/03/1_dBJMknulIZSAC36tTmanVA.jpeg" width= "300" title="top shows">
<!-- Show Submission Form -->
<form action="/addShow" method= "post">
<fieldset>
<legend>
Have Any Shows You Want To Watch?
</legend>
Show Name: <br>
<input type="text" id="showName"><br>
Director: <br>
<input type="text" id="directorName"><br>
Comments: <br>
<input type="text" id="comments"><br>
Rating (1-5): <br>
<input type="text" id="rating"><br>
<div id="submit-btn">
<button>Add My Show</button>
</div>
</fieldset>
</form>
<!-- The three tables -->

<div id="table-view">
<h1 class="center-txt table-label">Full Show List</h1>
<div style="height:150px; overflow-y: auto;">
<table class="table is-fullwidth">
<thead>
<tr><th>Name</th><th>Director</th><th>Comments</th><th>Rating</th></tr>
</thead>
<tbody id="all-shows">
</tbody>
</table>
</div>

<h1 class="center-txt table-label">Shows You Liked</h1>
<div style="height:150px; overflow-y: auto;">
<table class="table is-fullwidth">
<thead>
<tr><th>Name</th><th>Director</th><th>Comments</th><th>Rating</th></tr>
</thead>
<tbody id="good-shows">
</tbody>
</table>
</div>

<h1 class="center-txt table-label">Shows You Didn't Like</h1>
<div style="height:150px; overflow-y: auto;">
<table class="table is-fullwidth">
<thead>
<tr><th>Name</th><th>Director</th><th>Comments</th><th>Rating</th></tr>
</thead>
<tbody id="bad-shows">
</tbody>
</table>
</div>
</div>
<!-- End of table area -->
<!-- Show Submission Form -->
<form action="/delShow" method= "post">
<fieldset>
<legend>
Oops, Made A Mistake?
</legend>
Update Show: <br>
<div id="wrapper">
<div id="left-edit">
Name of Show:
<input type="text" id="editShowName">
</div>
<div id="right-edit">
New Rating:
<input type="text" id="editShowRating">
</div>
</div>
<br>
<div id="edit-btn">
<button>Update Show</button>
</div>

<br>Show Name to Delete: <br>
<input type="text" id="delShowName"><br>
<div id="del-btn">
<button>Delete Show</button>
</div>
</fieldset>
</form>
<br>
</body>
</html>
<script src="./js/scripts.js"></script>
</html>
Loading