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-akerekon-Andrew-Kerekon #99

Open
wants to merge 8 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
101 changes: 15 additions & 86 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,26 @@
Assignment 2 - Short Stack: Basic Two-tier Web Application using HTML/CSS/JS and Node.js
===
## A2 -- Andrew Kerekon -- WPI Student Preferences -- https://a2-akerekon.glitch.me/
For this project, I created a small survey form using the flexbox layout to collect data on WPI students' favorite dorms, dining halls, and spots on campus by class year. I included a "yearsRemaining" field that is derived from both a student's class year (4 for first-year, 3 for sophomore, 2 for junior, 1 for senior, and N/A for graduate students) and their name (the name "Gompei" is an easter egg that results in staying at WPI for another 100 years!). Additionally, pressing the "Step On The Seal" button will add 1 additional year to all undergraduate students in the table and any undergraduate students added before the next reload. This website can be used by scrolling to "Add A Rating" and entering data in all fields (with additional notes being optional), then pressing "Add This Rating!". Additionally, each row can be deleted by pressing the "Delete!" button, which will persist on reload.

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

This assignment aims to 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 over the life of a user session.

Baseline Requirements
---

There is a large 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, modify, 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.
- All pages should [validate](https://validator.w3.org)

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; no default fonts! 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 (make sure to fork the 2021 repo!). 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
---
## Technical Achievements
- **Tech Achievement 1**: 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.

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.
Based on this achievement and the clarification method in Discord, I implemented a form that adds user data about their name, class year, favorite dorm, favorite dining hall, and favorite spot on campus, and made sure to include a delete button next to each row. This was challenging as I had to calculate a derived field based on these input fields, which I implemented by creating a "yearsRemaining" field that took in a student's class year and name to determine how many years they had left at WPI, and even more if they hit the "Step On The Seal" button that would increment each year remaining by one or if their name was Gompei (Hidden Easter Egg!)!

*Technical*
- (10 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.
### Design/Evaluation Achievements
- **Design Achievement 1**: I tested my interface with two students from this class, Federico Galbiati and Steven Tran:

*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 find). Important considerations when designing your study:
**Evaluation 1 -- Federico Galbiati:**
What problems did the user have with your design? Federico liked the general layout and structure of my website, but noticed a few major bugs: at first, the responseID field would increment even if a user's submission was invalid, resulting in higher and higher responseIDs for valid submissions. Additionally, graduate students used to have a studentYear of "N/A0" instead of "N/A" when the seal was stepped on, as I mistakenly combined a string with a integer and tried to add them. Finally, pressing enter on a textbox when adding in form data would redirect to a non-existent webpage, which I have since fixed.

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!
What comments did they make that surprised you? Federico mentioned that some behavior wasn't expected, such as how stepping on the seal would impact all students, even ones added afterwards.

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. After completing each study, briefly (one to two sentences for each question) address the following in your README:
What would you change about the interface based on their feedback? I reprogrammed the responseID field to only increment on valid submissions, made it so the default value of studentYear was "" instead of "0," and made sure to "return false;" on those input forms to prevent redirecting to a non-existent page.

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.
**Evalulation 2 -- Steven Tran:**
What problems did the user have with your design: Steven liked the design, but felt that the header should have extended across the screen and was surrounded by a border, and also felt that the color scheme was a bit hard to read.

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---
What comments did they make that surprised you? Steven also mentioned how stepping on the seal affected all students, which seemed unfair to students who were added to the form after another person had stepped on the seal.

## 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.
What would you change about the interface based on their feedback? I'll make sure to change up the color scheme, layout, and borders to something more readable, especially to make it more accessible for all users. I'll also save which students have been affected by the seal to make sure new students do not get punished for something they were not involved in.

## Technical Achievements
- **Tech Achievement 1**: Using a combination of...

### Design/Evaluation Achievements
- **Design Achievement 1**:
Binary file added images/WPI_Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/WPI_Quad.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions node_modules/.bin/mime

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions node_modules/.bin/mime.cmd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions node_modules/.bin/mime.ps1

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions node_modules/.package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading